Automatic code documentation generation tool (to generate markdown files compatible with mkdocstrings)
Project description
Auto-Doc
A single file auto documentation builder made to be interfaced with mkdocstrings, and ran in containerized CI/CD
Drop it on top level of your package wrapper folder. It requires a setup.py wrapped package structure like so :
- :open_file_folder: PackageRepo
- :page_facing_up: setup.py
- :page_facing_up: auto-doc.py
- :page_facing_up: mkdocs.yml
- :open_file_folder: docs
- :page_facing_up: index.md
- :open_file_folder: Package
- :page_facing_up: __init__.py
- :page_facing_up: myfile.py
- :open_file_folder: mysubpackage
- :page_facing_up: __init__.py
- :page_facing_up: myfile2.py
Then, inside the top wrapping folder, PackageRepo, you can call auto-docs.py
like this :
python auto-docs.py Package
It requires a single command line argument that tells it what is the folder that contains the python source files in your wrapping folder.
That's all !
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
auto_fast_docs-2.0.1.tar.gz
(9.7 kB
view hashes)
Built Distribution
Close
Hashes for auto_fast_docs-2.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad284281eb232150c3174a73037e76aa1b030392b70cf9bf901c7d66c022e73a |
|
MD5 | 27575aa130d5d55e193a11aeb8b3d2d0 |
|
BLAKE2b-256 | 24cf58a37470e8a73e34c2d30eb1b839149ce55d3180dd5107aed8af40f1f6f6 |