summaryrefslogtreecommitdiff
path: root/docs/contributing
diff options
context:
space:
mode:
authorRob Thomas <xrobau@gmail.com>2019-11-11 05:42:50 +1000
committerChristian Poessinger <christian@poessinger.com>2019-11-10 20:42:50 +0100
commitb66cdf17ad4f76e05b4c3359372d4315e6306143 (patch)
tree16c32c25791e0ab4951405a52a419a9174fe6bea /docs/contributing
parent2ed61f8fd8b8be239ff92f30b2059e843cd6c50b (diff)
downloadvyos-documentation-b66cdf17ad4f76e05b4c3359372d4315e6306143.tar.gz
vyos-documentation-b66cdf17ad4f76e05b4c3359372d4315e6306143.zip
contribution: fix Markdown leftovers
Diffstat (limited to 'docs/contributing')
-rw-r--r--docs/contributing/documentation.rst12
1 files changed, 6 insertions, 6 deletions
diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst
index b3ade103..96fc167c 100644
--- a/docs/contributing/documentation.rst
+++ b/docs/contributing/documentation.rst
@@ -30,9 +30,8 @@ This requires you already have a GitHub account.
```
5. Make all your changes - please keep out commit rules in mind. This mainly
applies to a proper commit message describing your change. Please check the
- documentation if you aren't familiar with
- [sphinx-doc](http://http://www.sphinx-doc.org) or
- [reStructuredText](http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html)
+ documentation if you aren't familiar with `sphinx-doc <https://www.sphinx-doc.org>`_ or
+ `reStructuredText <http://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
Note the following RFCs, which describe the reserved public IP addresses and
autonomous system numbers for the documentation: RFC5737_, RFC3849_,
@@ -50,9 +49,10 @@ This requires you already have a GitHub account.
Please don't use other public address space.
6. Check your changes by locally building the documentation
- ```shell
- $ cd docs; make html
- ```
+ ```shell
+ $ cd docs; make html
+ ```
+
Sphinx will build the html files in the ``docs/_build`` folder
7. Add modified files to Git index