mirror of
https://github.com/outbackdingo/patroni.git
synced 2026-01-27 10:20:10 +00:00
b7ea511511
Expanding on the addition of docstrings in code, this adds python module API docs to sphinx documentation. A developer can preview what this might look like by running this locally: ``` tox -m docs ``` The option `-W` is added to the tox env so that warning messages are considered errors. Adds doc generation using the above method to the test GitHub workflow to catch documentation problems on PRs. Some docstrings have been reformatted and fixed to satisfy errors generated with the above setup.
27 lines
502 B
YAML
27 lines
502 B
YAML
# .readthedocs.yaml
|
|
# Read the Docs configuration file
|
|
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
|
|
|
|
# Required
|
|
version: 2
|
|
|
|
# Set the version of Python and other tools you might need
|
|
build:
|
|
os: ubuntu-22.04
|
|
tools:
|
|
python: "3.11"
|
|
|
|
# Build documentation in the docs/ directory with Sphinx
|
|
sphinx:
|
|
configuration: docs/conf.py
|
|
|
|
formats:
|
|
- epub
|
|
- pdf
|
|
- htmlzip
|
|
|
|
python:
|
|
install:
|
|
- requirements: requirements.docs.txt
|
|
- requirements: requirements.txt
|