proj_flow.ext.python.rtdocs

The proj_flow.ext.python.rtdocs defines RTDocs step (“RTD”), which uses .readthedocs.yaml to build the HTML documentation.

class proj_flow.ext.python.rtdocs.RTDocs

Runs the jobs defined by .readthedocs.yaml to build the docs

Name:

RTD

Requires:

python -m PyYAML

class proj_flow.ext.python.rtdocs.Builder

Base class for any recognized builder in the .readthedocs.yaml config.

abstract property READTHEDOCS_OUTPUT: str

abstract build(target: str) → int

wrap(target: str) → Callable[[], int]

class proj_flow.ext.python.rtdocs.Sphinx(config: str)

Builder used, if Sphinx config is found in the config file.

Parameters:

config – filename of a Python script Sphinx should use for the configuration

property READTHEDOCS_OUTPUT: str

A build/ subdirectory placed in the same dir, as config parameter

build(target: str) → int

Uses spinx-build to create the documentation.

Parameters:

target – name of the docs format from YAML config

Returns:

exit code forwarded from the build tool