diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-06-09 17:14:10 -0400 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-06-09 17:14:10 -0400 |
| commit | 055b77e8e9b7ab6ffdfcad8d01c0f20737dbd3dd (patch) | |
| tree | 88027f4c462d5246f277d569ab173ce9488b035b /doc/source/plugin.rsttemplate | |
| parent | 71b78794527bd231962736a5a207973fd02ad09d (diff) | |
| download | buildstream-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 'doc/source/plugin.rsttemplate')
| -rw-r--r-- | doc/source/plugin.rsttemplate | 5 |
1 files changed, 0 insertions, 5 deletions
diff --git a/doc/source/plugin.rsttemplate b/doc/source/plugin.rsttemplate index 4b252b647..d6ee9488f 100644 --- a/doc/source/plugin.rsttemplate +++ b/doc/source/plugin.rsttemplate @@ -1,6 +1 @@ -:orphan: - -@@MODULENAME@@ plugin -============================================ - .. automodule:: @@MODULE@@ |