Python code documentation compiler

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for SamWilsn from gravatar.com SamWilsn

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: GNU General Public License v3 or later (GPLv3+)

Requires: Python >=3.10

Classifiers

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

Verified details

These details have been verified by PyPI
Maintainers
Avatar for SamWilsn from gravatar.com SamWilsn

Unverified details

These details have not been verified by PyPI
Project links
GitHub Statistics

View statistics for this project via Libraries.io, or by using our public dataset on Google BigQuery

Meta

License: GNU General Public License v3 or later (GPLv3+)

Requires: Python >=3.10

Classifiers

Release history Release notifications | RSS feed

This version

0.2.0

0.1.0

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.0.tar.gz (68.1 kB view hashes)

Uploaded Source

Built Distribution

docc-0.2.0-py3-none-any.whl (93.7 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