ci(pre-commit): finalise rstcheck configuration [skip ci]

* Automated using https://github.com/myii/ssf-formula/pull/267
This commit is contained in:
Imran Iqbal 2020-10-10 06:42:53 +01:00
parent 2747e35ce1
commit 1c2125c251
No known key found for this signature in database
GPG Key ID: 6D8629439D2B7819
2 changed files with 10 additions and 3 deletions

View File

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

View File

@ -64,7 +64,7 @@ Example: NTP before applying TOFS
Let's work with the NTP example. A basic formula that follows the `design guidelines <http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_ has the following files and directories tree: Let's work with the NTP example. A basic formula that follows the `design guidelines <http://docs.saltstack.com/en/latest/topics/development/conventions/formulas.html>`_ has the following files and directories tree:
.. code-block:: .. code-block:: console
/srv/saltstack/salt-formulas/ntp-saltstack-formula/ /srv/saltstack/salt-formulas/ntp-saltstack-formula/
ntp/ ntp/
@ -226,7 +226,7 @@ We can make different templates coexist for different minions, classified by any
If we decide that we want ``os_family`` as switch, then we could provide the formula template variants for both the ``RedHat`` and ``Debian`` families. If we decide that we want ``os_family`` as switch, then we could provide the formula template variants for both the ``RedHat`` and ``Debian`` families.
.. code-block:: .. code-block:: console
/srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/files/ /srv/saltstack/salt-formulas/ntp-saltstack-formula/ntp/files/
default/ default/
@ -449,7 +449,7 @@ Using sub-directories for ``components``
If your formula is composed of several components, you may prefer to provides files under sub-directories, like in the `systemd-formula <https://github.com/saltstack-formulas/systemd-formula>`_. If your formula is composed of several components, you may prefer to provides files under sub-directories, like in the `systemd-formula <https://github.com/saltstack-formulas/systemd-formula>`_.
.. code-block:: .. code-block:: console
/srv/saltstack/systemd-formula/ /srv/saltstack/systemd-formula/
systemd/ systemd/