summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-06-09 17:23:23 -0400
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-06-09 17:23:23 -0400
commit5f794829baf2548d98af3af9eec75ea0b1d82c30 (patch)
treeab05f06e0b9211a97388f244868c9c0ab326615d
parent055b77e8e9b7ab6ffdfcad8d01c0f20737dbd3dd (diff)
downloadbuildstream-5f794829baf2548d98af3af9eec75ea0b1d82c30.tar.gz
doc/source/main_core.rst: Use a hidden toctree to hide away some things
Sphinx generates some library style module index, we just include it in a hidden toctree and avoid using it altogether.
-rw-r--r--doc/source/main_core.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/source/main_core.rst b/doc/source/main_core.rst
index c7be299ba..6571c4e42 100644
--- a/doc/source/main_core.rst
+++ b/doc/source/main_core.rst
@@ -15,4 +15,14 @@ other more elaborate details about BuildStream internals.
cachekeys
sandboxing
core_framework
+
+
+..
+ This is a hidden toctree so that the autogenerated
+ modules index is not orphaned, sort of a cheat because
+ we would rather present a manual toctree for this part.
+
+.. toctree::
+ :hidden:
+
modules