Zsh Mailing List Archive
Messages sorted by:
Reverse Date,
Date,
Thread,
Author
Re: Doxygen for shell scripts
- X-seq: zsh-users 22883
- From: "Nikolay Aleksandrovich Pavlov (ZyX)" <kp-pav@xxxxxxxxx>
- To: Sebastian Gniazdowski <psprint@xxxxxxxxxxx>, Zsh Users <zsh-users@xxxxxxx>
- Subject: Re: Doxygen for shell scripts
- Date: Sun, 10 Sep 2017 12:43:54 +0300
- Authentication-results: mxback6j.mail.yandex.net; dkim=pass header.i=@yandex.ru
- 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=
- In-reply-to: <etPan.59b4e3ca.42b18817.134@zdharma.org>
- List-help: <mailto:zsh-users-help@zsh.org>
- List-id: Zsh Users List <zsh-users.zsh.org>
- List-post: <mailto:zsh-users@zsh.org>
- Mailing-list: contact zsh-users-help@xxxxxxx; run by ezmlm
- References: <etPan.59b4e3ca.42b18817.134@zdharma.org>
10.09.2017, 10:16, "Sebastian Gniazdowski" <psprint@xxxxxxxxxxx>:
> 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).
Messages sorted by:
Reverse Date,
Date,
Thread,
Author