Skip to content

Commit

Permalink
Add rstcheck support
Browse files Browse the repository at this point in the history
This tool checks reStructuredText syntax helping to detect non-trivial
documentation issues.

Signed-off-by: Victor Morales <v.morales@samsung.com>
  • Loading branch information
electrocucaracha committed Dec 16, 2022
1 parent 354f89e commit f919ce9
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 1 deletion.
4 changes: 4 additions & 0 deletions .rstcheck.cfg
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
[rstcheck]
report_level=ERROR
ignore_directives=bibliography,
ignore_roles=cite:p,
3 changes: 2 additions & 1 deletion doc/gov/chapters/chapter09.rst
Original file line number Diff line number Diff line change
Expand Up @@ -220,7 +220,8 @@ experience. This survey will be used to measure the feasibility, utility, and ef
installation/configuration methods and RC-1 Test case efficacy. The survey will be in an Agile User Story format. The
Table below provides an example of the survey questions:

![\ **Table 1:** Survey/Questionnaire example](../figures/Table 1-1.png)
.. image:: ../figures/Table_1-1.png
:alt: "Table 1: Survey/Questionnaire example"

**Table 1:** Survey/Questionnaire example

Expand Down
File renamed without changes
1 change: 1 addition & 0 deletions test-requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ sphinx!=1.6.6,!=1.6.7,!=2.1.0,!=3.0.0,!=3.4.2 # BSD
doc8 # Apache-2.0
sphinx-material
pyspelling # MIT
rstcheck[sphinx] # MIT
3 changes: 3 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,13 @@ skipsdist = true

[testenv:docs]
basepython = python3.10
allowlist_externals = bash
deps =
-chttps://opendev.org/openstack/requirements/raw/branch/stable/zed/upper-constraints.txt
-r{toxinidir}/test-requirements.txt
commands =
bash -c "find {toxinidir} -not -path {toxinidir}/.tox/\* \
-name \*.rst -type f -print0 | xargs -0 rstcheck"
sphinx-build -W --keep-going -W -T -b html -D language=en doc _build/html
sphinx-build -W --keep-going -W -b linkcheck doc _build/html
pyspelling -c .spellcheck.yml

0 comments on commit f919ce9

Please sign in to comment.