Re: Doxygen for shell scripts

["Nikolay Aleksandrovich Pavlov (ZyX)" <kp-pav@yandex.ru>]

10.09.2017, 10:16, "Sebastian Gniazdowski" <psprint@zdharma.org>:
> 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).