Stibnite is an automated documentation generator that can work with different docstring styles. (and hopefully in the future different programming languages)
Report Bug
·
Request Feature
Stibnite is a powerful tool that can create a website for the documentation of your codebase by parsing python files (for now), extracting docstrings from functions, classes, methods and, etc. and creating a stylized markdown based webpage using mkdocs.
It can
- parse python files to extract docstrings
- parse docstrings to create a webpage
- create a website out of your codebase
- customize the output based on your choices
- ignore the files that you don't want them to be in the documentation
- Python
- reStructured Text
- Markdown
The easiest way to install this tool is via pip
pip install stibnite
Still in development process
Our vision for this project is to create a tool that can automatically create a customizable documentation in every possible language with every possible docstring style to free the software developers from the burden of writing dreaded documentation.
You can reach what we are planning for our next version in here
Distributed under the Apache 2.0 License. See LICENSE for more information.
As the developers of this project we take it as one's duty to thank AlexandreKempf and other contributers in the automacdoc project as they are the visionary fathers/mothers of stibnite and Hikmet Dogan for his beautiful work on our logo.
