diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/contributing/documentation.rst | 14 |
2 files changed, 13 insertions, 3 deletions
diff --git a/docs/conf.py b/docs/conf.py index 4c8989ef..d82f292c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -189,5 +189,3 @@ def vytask_role(name, rawtext, text, lineno, inliner, options={}, content=[]): def setup(app): pass - #app.add_object_type('opcmd', 'opcmd') - #app.add_object_type('cfgcmd', 'cfgcmd') diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst index 2d9f14d1..8102e9a9 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -171,6 +171,12 @@ descriptive way in the resulting HTML/PDF manual. This will configure a static ARP entry always resolving `192.0.2.100` to `00:53:27:de:23:aa`. +For a inline configuration level command use ``:cfgcmd:`` + +.. code-block:: none + + :cfgcmd:`set interface ethernet eth0` + opcmd """"" @@ -186,10 +192,16 @@ descriptive way in the resulting HTML/PDF manual. Display all known ARP table entries spanning across all interfaces +For a inline operational level command use ``:opcmd:`` + +.. code-block:: none + + :opcmd:`add system image` + vytask """""" -When referencing to VyOS Phabricator Tasks, there is a custom Spinx Markup +When referencing to VyOS Phabricator Tasks, there is a custom Sphinx Markup command called ``vytask`` which automatically renders to a proper Phabricator URL. This is heavily used in the :ref:`release-notes` section. |