Python: Sphinx docs linting workflow

open-contracting / software-development-handbook

A guide for developers of OCP's tools

https://ocp-software-handbook.readthedocs.io/en/latest/

Other

4 stars 1 forks source link

Python: Sphinx docs linting workflow #35

Closed jpmckinney closed 2 years ago

jpmckinney commented 3 years ago

Try out https://pypi.org/project/doc8/
Test docs builds using sphinx-build -nW

Policy can be added to Python documentation page.

Technically, this could apply to any Sphinx RST documentation, but I think we only use Sphinx to document Python projects.

jpmckinney commented 3 years ago

Similar issue for Markdown: https://github.com/open-contracting/standard-development-handbook/issues/239 The standard documentation repositories already use sphinx-build -nW.

jpmckinney commented 3 years ago

Related: #30

jpmckinney commented 2 years ago

Doc8 just changes whitespace, which is not important. The .readthedocs.yaml file in our cookiecutters turns on error-on-warning, and ReadTheDocs sends email notifications to admins, so we don’t need a GitHub workflow for this.