-
-
Notifications
You must be signed in to change notification settings - Fork 660
Closed
Milestone
Description
Short of running a single-file docbuild (which needs fixing - #30475), there are several options for validating rst files and docstrings:
- https://pypi.org/project/rstcheck/
- https://pypi.org/project/doc8/
- https://pypi.org/project/flake8-rst-docstrings
- https://pypi.org/project/flake8-docstrings/ (uses https://github.com/pycqa/pydocstyle)
Here we add a tox environment using https://pypi.org/project/flake8-rst-docstrings.
Usage:
./sage -tox -e rst src/sage/geometry/polyhedra
We also run it as part of the Lint workflow on GH Actions (see badge).
Continued in the meta ticket: #34157
Depends on #30503
CC: @tobiasdiez @jhpalmieri @dimpase @fchapoton @DaveWitteMorris @Etn40ff @tscrim @kwankyu
Component: documentation
Author: Matthias Koeppe
Branch/Commit: 0677319
Reviewer: Kwankyu Lee
Issue created by migration from https://trac.sagemath.org/ticket/30448