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.5.1.tar.gz (72.0 kB view details)

Uploaded Source

Built Distribution

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

docc-0.5.1-py3-none-any.whl (98.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: docc-0.5.1.tar.gz
  • Upload date:
  • Size: 72.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.13

File hashes

Hashes for docc-0.5.1.tar.gz
Algorithm Hash digest
SHA256 b58f7cf8fb4010afb3828b034393244be899820b1bbf7661d7982f697ec78bdb
MD5 1f115229a31be0a3a10ce256a67e7524
BLAKE2b-256 6fcd2843f0f6cb0a3bc2d4cf070477aab8779fdde7a07c83d91b7827a67d45bb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: docc-0.5.1-py3-none-any.whl
  • Upload date:
  • Size: 98.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.13

File hashes

Hashes for docc-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5d82e7b0c654ee7de6e6988ee677ff4ac93b427f19d82546941eda96d2f546c7
MD5 8d881ea2ddddebe836e7ac4073d1c3d8
BLAKE2b-256 00828c21566c89fd1b76b4ee18e0ef86ded549a3aa7cb63d77c4aaccd00d64e1

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