diff options
author | James Ennis <james.ennis@codethink.com> | 2018-04-16 16:10:38 +0100 |
---|---|---|
committer | James Ennis <james.ennis@codethink.com> | 2018-04-17 17:07:08 +0100 |
commit | abec38fb21c5e75d92760d460184fd7eacb4226d (patch) | |
tree | b2edc842afded01e3a40de2b4ff539655fab9106 | |
parent | 731f009a156d271b59f91c040e57a31e99ed0d39 (diff) | |
download | buildstream-documentation-formatting-in-HACKING.tar.gz |
HACKING.rst: move location of useful linksdocumentation-formatting-in-HACKING
-rw-r--r-- | HACKING.rst | 7 |
1 files changed, 2 insertions, 5 deletions
diff --git a/HACKING.rst b/HACKING.rst index c45ef1e0a..30fb29742 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -209,11 +209,6 @@ Documenting BuildStream BuildStream starts out as a documented project from day one and uses sphinx to document itself. -Useful links: - -* Sphinx documentation: http://www.sphinx-doc.org/en/1.4.8/contents.html -* rst primer: http://www.sphinx-doc.org/en/stable/rest.html - Documentation formatting policy ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -233,6 +228,8 @@ The BuildStream documentation style is as follows: * To cross reference arbitrary locations with, for example, the anchor ``_anchor_name``, you must give the link an explicit title: ``:ref:`Link text <anchor_name>```. Note that the "_" prefix is not required. +Useful links: + For further information, please see the `Sphinx Documentation <http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html>`_. |