Skip to main content

stupid simple autodoc

Project description

gautodoc

stupid simple autodoc.

how do I use your stupid tool?

gautodoc operates by looking at the 'roots' of your python project and recursively searching for imported modules that are part of your project directory.

if you just want to document a script with some imports, you can just:

gautodoc init your-script.py

this will create .gautodoc in your project folder. gautodoc init can also be used to reconfigure your project if you need it to.

once .gautodoc exists, you can run:

gautodoc build

and a doc/ folder containing a simple static web app will appear!

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

gautodoc-0.0.1.tar.gz (8.6 kB view hashes)

Uploaded Source

Built Distribution

gautodoc-0.0.1-py3-none-any.whl (11.0 kB view hashes)

Uploaded Python 3

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