Skip to content
forked from SamWilsn/docc

Documentation generator for Python

License

Notifications You must be signed in to change notification settings

Carsons-Eels/docc

 
 

Repository files navigation

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

About

Documentation generator for Python

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 86.0%
  • HTML 9.4%
  • CSS 2.4%
  • JavaScript 2.2%