A Python documentation utility.
Project description
# catnado-docgen
A Python documentation utility designed to work with mkdocs.
Originally built for [gae-catnado](https://tylertrussell.github.io/gae-catnado), but could be useful for other projects, too.
Install via pip install catnado-docgen.
This is a work in progress! Expect bugs and unannounced changes.
Real changelog to follow.
## Instructions
#### In conjunction with mkdocs.yaml
To document a package in a project that has a mkdocs.yaml file, simply run: ` docgen build packagename mkdocs.yml --update-pages `
This scans packagename recursively, extracting Python docstrings and building Markdown source files from them.
The new Markdown files are written to a folder called docgen-api in your docs_dir (as specified in mkdocs.yml).
The –update-pages option updates the mkdocs.yml pages entry to contain a nested structure of packages and submodules under the heading docgen-api.
#### Without mkdocs.yml
If you want to do something else with the generated markdown documents, you can just specify an output directory like so:
docgen build packagename /my/path/here
This will write the Markdown source to the specified directory.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for catnado_docgen-0.0.1.dev2-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4c6dc3da3cc4530ee942b3b2fda206fe06ba2558b2af0e43eb632fcba5c625d |
|
MD5 | ac44de905b551e79e78d5c682eec8619 |
|
BLAKE2b-256 | f654fbd5923b9c748c233d7ba80092f7d6bd1abc93c7501abe034ce6cf86931b |