summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-11-08 09:07:48 +0100
committerChristian Poessinger <christian@poessinger.com>2020-11-08 09:07:48 +0100
commit58ab5850f3b6a11d46fdc6b187024fd6f704126d (patch)
tree7c30cd5765b70c19f213e3fe72edd7f4cb27f66a /docs
parentf84eb6a3c86ba5d1820d64fcfad22cd5bc61eed1 (diff)
downloadvyos-documentation-58ab5850f3b6a11d46fdc6b187024fd6f704126d.tar.gz
vyos-documentation-58ab5850f3b6a11d46fdc6b187024fd6f704126d.zip
documentation: add link to RST directives
Diffstat (limited to 'docs')
-rw-r--r--docs/contributing/documentation.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst
index 2b2d3ba7..92af881c 100644
--- a/docs/contributing/documentation.rst
+++ b/docs/contributing/documentation.rst
@@ -46,7 +46,8 @@ access to the official codebase.
(:ref:`prepare_commit`). This mainly applies to proper commit messages
describing your change (how and why). Please check out the documentation of
Sphinx-doc_ or reStructuredText_ if you are not familiar with it. This is used
- for writing our docs.
+ for writing our docs. Additional directives how to write in RST can be obtained
+ from reStructuredTextDirectives_.
* Check your changes by locally building the documentation ``$ make html``.
Sphinx will build the html files in the ``docs/_build`` folder. We provide
@@ -175,7 +176,7 @@ descriptive way in the resulting HTML/PDF manual.
For a inline configuration level command use ``:cfgcmd:``
.. code-block:: none
-
+
:cfgcmd:`set interface ethernet eth0`
opcmd
@@ -196,7 +197,7 @@ descriptive way in the resulting HTML/PDF manual.
For a inline operational level command use ``:opcmd:``
.. code-block:: none
-
+
:opcmd:`add system image`
vytask
@@ -214,6 +215,7 @@ URL. This is heavily used in the :ref:`release-notes` section.
.. _Sphinx-doc: https://www.sphinx-doc.org
.. _reStructuredText: http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html
+.. _reStructuredTextDirectives: https://docutils.sourceforge.io/docs/ref/rst/directives.html
.. _README.md: https://github.com/vyos/vyos-documentation/blob/master/README.md
.. include:: ../common-references.rst