mirror of
https://github.com/codex-storage/deluge.git
synced 2025-01-12 04:24:27 +00:00
65f6ede8b2
- Updates to the sphinx conf - Applied Mock fixes to build on Python 3. - Group patches at bottom of conf file. - Use just a major.minor for version. - Specify Sphinx 2.0 version requirement. - Move requirements.txt to docs dir. - Add readthedocs config - Fix docstring code block rst formatting issue.
15 lines
287 B
Markdown
15 lines
287 B
Markdown
# Documentation contributions
|
|
|
|
## Build
|
|
|
|
We use Sphinx to create the documentation from source files and docstrings in code.
|
|
|
|
pip install -r docs/requirements.txt
|
|
python setup.py build_docs
|
|
|
|
The resulting html files are in `docs/build/html`.
|
|
|
|
## man pages
|
|
|
|
Located in `docs/man`
|