diff options
| author | Christian Poessinger <christian@poessinger.com> | 2019-12-30 13:36:42 +0100 |
|---|---|---|
| committer | Christian Poessinger <christian@poessinger.com> | 2019-12-30 13:36:42 +0100 |
| commit | 3a8e3b1e9c392b37eebbf1d3927965c4e4e2aa72 (patch) | |
| tree | b2f217e1c53855e8d7f48fa5a8bde2c63137296c /docs/contributing/documentation.rst | |
| parent | 37ad1d5bc694daf3ffd7ad8ef317cdb42735c425 (diff) | |
| download | vyos-documentation-3a8e3b1e9c392b37eebbf1d3927965c4e4e2aa72.tar.gz vyos-documentation-3a8e3b1e9c392b37eebbf1d3927965c4e4e2aa72.zip | |
documentation: split cfgcmd/opcmd description
Diffstat (limited to 'docs/contributing/documentation.rst')
| -rw-r--r-- | docs/contributing/documentation.rst | 35 |
1 files changed, 27 insertions, 8 deletions
diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst index c639651b..1cf93313 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -147,16 +147,38 @@ system numbers for the documentation: Please don't use other public address space. - Custom Sphinx-doc Markup ^^^^^^^^^^^^^^^^^^^^^^^^ +When writing the cducmentation custom commands have been developed. Please +make yourself comfortable with those commands as this eases the way how we +can render the ducumentation. + +cfgcmd +"""""" + When documenting CLI commands use the ``.. cfgcmd::`` directive for all -configuration mode commands. When documenting operational level command use -the ``.. opcmd::`` directive. An explanation of the described command should -be added below this statement. +configuration mode commands. An explanation of the described command should be +added below this statement. + +With those custom commands it will be possible to render them in a more +descriptive way in the resulting HTML/PDF manual. + +.. code-block:: none + + .. cfgcmd:: set protocols static arp 192.0.2.100 hwaddr 00:53:27:de:23:aa -**Example** + This will configure a static ARP entry always resolving `192.0.2.100` to + `00:53:27:de:23:aa`. + +opcmd +""""" + +When documenting operational level command use the ``.. opcmd::`` directive. +An explanation of the described command should be added below this statement. + +With those custom commands it will be possible to render them in a more +descriptive way in the resulting HTML/PDF manual. .. code-block:: none @@ -164,10 +186,7 @@ be added below this statement. Display all known ARP table entries spanning accross all interfaces - .. cfgcmd:: set protocols static arp 192.0.2.100 hwaddr 00:53:27:de:23:aa - This will configure a static ARP entry always resolving `192.0.2.100` to - `00:53:27:de:23:aa`. .. _Sphinx-doc: https://www.sphinx-doc.org .. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html |