From b66cdf17ad4f76e05b4c3359372d4315e6306143 Mon Sep 17 00:00:00 2001 From: Rob Thomas Date: Mon, 11 Nov 2019 05:42:50 +1000 Subject: contribution: fix Markdown leftovers --- docs/contributing/documentation.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) (limited to 'docs/contributing') 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 `_ or + `reStructuredText `_ 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 -- cgit v1.2.3