Skip to content

Commit 617a3db

Browse files
Add rstcheck support
This tool checks reStructuredText syntax helping to detect non-trivial documentation issues. Signed-off-by: Victor Morales <v.morales@samsung.com>
1 parent e9571da commit 617a3db

File tree

5 files changed

+9
-1
lines changed

5 files changed

+9
-1
lines changed

.rstcheck.cfg

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[rstcheck]
2+
report_level=WARNING
3+
ignore_directives=bibliography,
4+
ignore_roles=cite:p,

doc/gov/chapters/chapter09.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,8 @@ Expectation #3: The Qualitative Survey
154154

155155
At the conclusion of the Test Case iterations, the participant will be asked to complete a qualitative survey of their experience. This survey will be used to measure the feasibility, utility, and effectiveness of the RI1 specifications, 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:
156156

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

159160
**Table 1:** Survey/Questionnaire example
160161

File renamed without changes.

test-requirements.txt

+1
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,4 @@ sphinx!=1.6.6,!=1.6.7,!=2.1.0,!=3.0.0,!=3.4.2 # BSD
55
doc8 # Apache-2.0
66
sphinx-material
77
pyspelling # MIT
8+
rstcheck[sphinx] # MIT

tox.ini

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ deps =
1010
-chttps://opendev.org/openstack/requirements/raw/branch/stable/xena/upper-constraints.txt
1111
-r{toxinidir}/test-requirements.txt
1212
commands =
13+
bash -c "find {toxinidir} -not -path {toxinidir}/.tox/\* \
14+
-name \*.rst -type f -print0 | xargs -0 rstcheck"
1315
sphinx-build --keep-going -W -T -b html -D language=en doc _build/html
1416
sphinx-build --keep-going -W -b linkcheck doc _build/html
1517
pyspelling -c .spellcheck.yml

0 commit comments

Comments
 (0)