summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-10-14 16:24:53 +0100
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-10-14 16:24:53 +0100
commitc31ed138734b2081b6c1c05a6ba59a158ecafab0 (patch)
tree10ffb2bf2991c6f64b9472def1e9f265f1c569ba /doc
parent3738dd06eeb59b8d275f59890dc812e00d274ff0 (diff)
downloadbuildstream-c31ed138734b2081b6c1c05a6ba59a158ecafab0.tar.gz
CONTRIBUTING.rst: Added more guidelines about documenting the user guide
Diffstat (limited to 'doc')
-rw-r--r--doc/source/main_using.rst2
-rw-r--r--doc/source/using_examples.rst3
-rw-r--r--doc/source/using_tutorial.rst3
3 files changed, 8 insertions, 0 deletions
diff --git a/doc/source/main_using.rst b/doc/source/main_using.rst
index 5f71ebddd..d56023e74 100644
--- a/doc/source/main_using.rst
+++ b/doc/source/main_using.rst
@@ -1,5 +1,7 @@
+.. _using:
+
Using
=====
This section includes user facing documentation including tutorials,
diff --git a/doc/source/using_examples.rst b/doc/source/using_examples.rst
index 622b09e32..18b15c711 100644
--- a/doc/source/using_examples.rst
+++ b/doc/source/using_examples.rst
@@ -1,4 +1,7 @@
+
+.. _examples:
+
Examples
========
This page contains documentation for real examples of BuildStream projects,
diff --git a/doc/source/using_tutorial.rst b/doc/source/using_tutorial.rst
index 190c94c8d..297f2341c 100644
--- a/doc/source/using_tutorial.rst
+++ b/doc/source/using_tutorial.rst
@@ -1,4 +1,7 @@
+
+.. _tutorial:
+
Tutorial
========
This is a step by step walkthrough meant help the user quickly get