diff options
| author | rebortg <github@ghlr.de> | 2020-12-11 11:49:47 +0100 |
|---|---|---|
| committer | rebortg <github@ghlr.de> | 2020-12-11 11:49:47 +0100 |
| commit | 23fa394cb212ecf4f26e0816ccf390f989b84970 (patch) | |
| tree | 2d899f63421ceca32a455855f5be7f51c4fce5b4 /docs/documentation.rst | |
| parent | 365be1770647cfb7fe35356730ab2a6289a14f4f (diff) | |
| download | vyos-documentation-23fa394cb212ecf4f26e0816ccf390f989b84970.tar.gz vyos-documentation-23fa394cb212ecf4f26e0816ccf390f989b84970.zip | |
linter add start/stop function with rst comments
Diffstat (limited to 'docs/documentation.rst')
| -rw-r--r-- | docs/documentation.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/docs/documentation.rst b/docs/documentation.rst index f1dc8095..3a2bfdcb 100644 --- a/docs/documentation.rst +++ b/docs/documentation.rst @@ -163,6 +163,17 @@ Except in ``.. code-block::`` because it will use the html tag ``<pre>`` which have the save line format as in the rst file. +Autolinter +^^^^^^^^^^ + +Each GitHub Pull request will automatically lint against the Address space and +line length. + +Sometimes it is necessary to provide real IP Addresses like in the +:ref:`examples`. For this please use the sphinx comment syntax +``.. stop_vyoslinter`` to stop the linter and ``.. start_vyoslinter`` to start. + + Custom Sphinx-doc Markup ^^^^^^^^^^^^^^^^^^^^^^^^ |