From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 16514 invoked by alias); 10 Sep 2017 09:50:40 -0000 Mailing-List: contact zsh-users-help@zsh.org; run by ezmlm Precedence: bulk X-No-Archive: yes List-Id: Zsh Users List List-Post: List-Help: X-Seq: 22883 Received: (qmail 2651 invoked by uid 1010); 10 Sep 2017 09:50:40 -0000 X-Qmail-Scanner-Diagnostics: from forward3p.cmail.yandex.net by f.primenet.com.au (envelope-from , uid 7791) with qmail-scanner-2.11 (clamdscan: 0.99.2/21882. spamassassin: 3.4.1. Clear:RC:0(77.88.31.18):SA:0(-2.6/5.0):. Processed in 2.783288 secs); 10 Sep 2017 09:50:40 -0000 X-Spam-Checker-Version: SpamAssassin 3.4.1 (2015-04-28) on f.primenet.com.au X-Spam-Level: X-Spam-Status: No, score=-2.6 required=5.0 tests=BAYES_00,FREEMAIL_FROM, RCVD_IN_DNSWL_LOW,SPF_PASS,T_DKIM_INVALID autolearn=ham autolearn_force=no version=3.4.1 X-Envelope-From: kp-pav@yandex.ru X-Qmail-Scanner-Mime-Attachments: | X-Qmail-Scanner-Zip-Files: | DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=yandex.ru; s=mail; t=1505036635; bh=IPS/K9gMK1XLO46cxoY0YY/0zP1Dg68yEkWF2QwcBLU=; h=From:To:In-Reply-To:References:Subject:Message-Id:Date; b=lkraNRV2epjQ1kmGYewWZwFd46KHlQAGXDogorf80nHqW8dK3t5RfOXPq8IYVsyG+ FFuFvAcHEPasTufrO1lQqMBz8gOeBrPIDJeGjq2ty2FApjsGZftEnL8G2VDGRErTk0 yyW9lYn2rYM48jd9JSWpmg5dkyyDs//GIDGNMwJw= Authentication-Results: mxback6j.mail.yandex.net; dkim=pass header.i=@yandex.ru From: "Nikolay Aleksandrovich Pavlov (ZyX)" To: Sebastian Gniazdowski , Zsh Users In-Reply-To: References: Subject: Re: Doxygen for shell scripts MIME-Version: 1.0 Message-Id: <2669581505036634@web1j.yandex.ru> X-Mailer: Yamail [ http://yandex.ru ] 5.0 Date: Sun, 10 Sep 2017 12:43:54 +0300 Content-Transfer-Encoding: 8bit Content-Type: text/plain; charset=utf-8 10.09.2017, 10:16, "Sebastian Gniazdowski" : > Hello > I've written a documentation generator for shell scripts. Example outputs: > > https://github.com/zdharma/zshelldoc/tree/master/examples > > It is based on (z) flag, works very robust. Supported are things like autoload functions and calls between scripts. I think the most power comes from call trees and comment extraction – this allows to analyze the code – but I plan to add some more things, like detection of usage of Zle, eval, add-zsh-hook, etc. > > -- > Sebastian Gniazdowski > psprint /at/ zdharma.org Why not a sphinx plugin? It is most logical: you need to teach it how to extract documentation comments and whatever those “more things” you want and it takes the job of yielding nicely formatted documentation in many different formats (one of which includes man pages), provides ability to host the generated documentation on readthedocs (but you still can have static pages on github.io or anwhere else if you want), TOC (table of contents) generating, cross-referencing, code highlighting (via pygments), searching (by default: local javascript-based search, not as good as google or properly configured another sphinx, but usable).