Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

catnado_docgen-0.0.1.dev2-py2-none-any.whl (7.6 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page