diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 528f996b..4f05fda5 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -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] diff --git a/.rstcheck.cfg b/.rstcheck.cfg new file mode 100644 index 00000000..05856dc7 --- /dev/null +++ b/.rstcheck.cfg @@ -0,0 +1,3 @@ +[rstcheck] +report=error +ignore_language=rst diff --git a/docs/CONTRIBUTING_DOCS.rst b/docs/CONTRIBUTING_DOCS.rst index da01c703..b68bb77a 100644 --- a/docs/CONTRIBUTING_DOCS.rst +++ b/docs/CONTRIBUTING_DOCS.rst @@ -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