HomeSoftware Heritage

sphinx/conf.py: Add standalone package doc configuration for tox build

Description

sphinx/conf.py: Add standalone package doc configuration for tox build

Enable to build the local documentation of each swh package using a
dedicated tox environment.

In order to check for possibly introduced sphinx warnings in the
documentation sources, the documentation is built with the -W option
of sphinx-build.

As some references located in scopes external to the processed
package would not be resolved, related sphinx warnings are
suppressed to allow the doc build to succeed anyway.

Besides the errors related to references that can only be checked
when building the full documentation, all other sphinx errors
should be caught.

Related to T3258

Details

Provenance
anlambertAuthored on Apr 19 2021, 12:56 PM
anlambertPushed on Apr 23 2021, 5:18 PM
Differential Revision
D5571: sphinx/conf.py: Add standalone package doc configuration for tox build
Parents
rDDOCa8ca608e4f53: Include class docstrings in the autodocumentation.
Branches
Unknown
Tags
Unknown
Tasks
T3258: Build documentation on every diff