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 details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

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

Uploaded Python 3

File details

Details for the file gautodoc-0.0.1.tar.gz.

File metadata

  • Download URL: gautodoc-0.0.1.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for gautodoc-0.0.1.tar.gz
Algorithm Hash digest
SHA256 a9b20d8fffa4f9b6555b559a0fa607d4c6c394a0e0d25ac449a54dc148e56ca3
MD5 d1d68b294640321b7821dd00dd960c0b
BLAKE2b-256 af8155e686b392e061620dd853071f04e077fc7ab2f5360496da43b4438622e7

See more details on using hashes here.

File details

Details for the file gautodoc-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: gautodoc-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 11.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for gautodoc-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f5749b5be0d53326e0ff242550a27a28df7b21c2176b380e6fee4d4200b9623e
MD5 edf38b3f52efdfdf5f76eae9909f9fa3
BLAKE2b-256 3932fccbb68bf38260c6ba104617a456b4c6720b44c6a1ea1e8f93a04b87470e

See more details on using hashes here.

Supported by

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