vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

contribution: fix Markdown leftovers

Browse Source
This commit is contained in:
Rob Thomas 2019-11-11 05:42:50 +10:00 committed by Christian Poessinger
parent 2ed61f8fd8
commit b66cdf17ad
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/contributing/documentation.rst
View File

@ -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