Skip to main content

Python code documentation compiler

Project description

docc

documentation badge

The documentation compiler.

Python Quickstart

Installing

pip install docc

Configuring

Add the following to your pyproject.toml:

[tool.docc.plugins."docc.python.discover"]
paths = [ "<path to Python source>" ]

[tool.docc.output]
path = "<where to put rendered documentation>"

Building

Finally, to generate the documentation:

docc

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

docc-0.2.2.tar.gz (68.3 kB view details)

Uploaded Source

Built Distribution

docc-0.2.2-py3-none-any.whl (93.8 kB view details)

Uploaded Python 3

File details

Details for the file docc-0.2.2.tar.gz.

File metadata

  • Download URL: docc-0.2.2.tar.gz
  • Upload date:
  • Size: 68.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for docc-0.2.2.tar.gz
Algorithm Hash digest
SHA256 e38ed6c981134d475413745526caeaff7c35efb9243a647023a1ed71ae0981e9
MD5 e09a151d81aa6b71268c56b8afc04eff
BLAKE2b-256 cd282fb913be9c6ba9bd4675d5019499bc7daae65497d3053c2255e7d13fccd0

See more details on using hashes here.

File details

Details for the file docc-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: docc-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 93.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for docc-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 74dd962fcc9099b6a0b910b8a8bb34147ebe2fa10ee26c2cbaa2f76427de1dcd
MD5 34797a3ba95ee7be935d7525bedd85b4
BLAKE2b-256 d714a1c41c4de7effda5af87db8be73b0befaacbda4078c54b1cc4bf5b82eee2

See more details on using hashes here.

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