saltstack-formulas/template-formula
1
0
Fork 0
mirror of https://github.com/saltstack-formulas/template-formula.git synced 2025-04-10 14:51:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(pre-commit): check reST files using rstcheck

Browse source
This commit is contained in:
Dafydd Jones 2020-07-28 13:39:59 +01:00
parent 6da26cca6a
commit a1d53a9758
3 changed files with 11 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
.pre-commit-config.yaml
View file

@ -48,3 +48,9 @@ repos:
- id: salt-lint
name: Check Salt files using salt-lint
files: ^.*\.(sls|jinja|j2|tmpl|tst)$
- repo: https://github.com/myint/rstcheck
rev: 3f929574
hooks:
- id: rstcheck
name: Check reST files using rstcheck
args: [--report=warning]

3
.rstcheck.cfg Normal file
View file

@ -0,0 +1,3 @@
[rstcheck]
report=error
ignore_language=rst

4
docs/CONTRIBUTING_DOCS.rst
View file

@ -34,11 +34,11 @@ Adding a new page involves two steps:
a. Do not just append it to the list.
#. Select the best place where it fits within the overall documentation.
.. _saltstack_formulas_rst_page_template:
SaltStack-Formulas' RST page template
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. _saltstack_formulas_rst_page_template
Use the following template when creating a new page.
This ensures consistency across the documentation for this formula.
The heading symbols have been selected in accordance to the output rendered by the