summaryrefslogtreecommitdiff
path: root/buildstream/plugins/elements/autotools.py
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-06-09 17:14:10 -0400
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-06-09 17:14:10 -0400
commit055b77e8e9b7ab6ffdfcad8d01c0f20737dbd3dd (patch)
tree88027f4c462d5246f277d569ab173ce9488b035b /buildstream/plugins/elements/autotools.py
parent71b78794527bd231962736a5a207973fd02ad09d (diff)
downloadbuildstream-055b77e8e9b7ab6ffdfcad8d01c0f20737dbd3dd.tar.gz
doc: Added plugins as ToC elements instead of orphaned links
o Now the page titles are declared in plugins, allowing for a more descriptive ToC o Makefile and plugin.rsttemplate updated to not produce the title, to no longer use `:orphan:` for plugin pages, and to ignore any private modules in the plugin directories. o Interestingly, now the docs will fail to build if you add a new plugin and forget to add it to the documentation.
Diffstat (limited to 'buildstream/plugins/elements/autotools.py')
-rw-r--r--buildstream/plugins/elements/autotools.py5
1 files changed, 3 insertions, 2 deletions
diff --git a/buildstream/plugins/elements/autotools.py b/buildstream/plugins/elements/autotools.py
index 5f54c3953..93fc6be87 100644
--- a/buildstream/plugins/elements/autotools.py
+++ b/buildstream/plugins/elements/autotools.py
@@ -18,8 +18,9 @@
# Authors:
# Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
-"""Autotools build element
-
+"""
+autotools - Autotools build element
+===================================
This is a :mod:`BuildElement <buildstream.buildelement>` implementation for
using Autotools build scripts (also known as the `GNU Build System
<https://en.wikipedia.org/wiki/GNU_Build_System>`_).