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/Makefile | |
| 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/Makefile')
| -rw-r--r-- | doc/Makefile | 5 |
1 files changed, 2 insertions, 3 deletions
diff --git a/doc/Makefile b/doc/Makefile index c894a135e..9cc3f488b 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -43,13 +43,12 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source # from plugin documentation. # define plugin-doc-skeleton - @for file in $$(find ${1} -name "*.py" ! -name "__init__.py"); do \ + @for file in $$(find ${1} -name "*.py" ! -name "_*.py"); do \ base=$$(basename $$file); \ module=${2}.$${base%.py}; \ modname=$${base%.py}; \ echo -n "Generating source/${2}/$${modname}.rst... "; \ - sed -e "s|@@MODULENAME@@|$${modname}|g" \ - -e "s|@@MODULE@@|$${module}|g" \ + sed -e "s|@@MODULE@@|$${module}|g" \ source/plugin.rsttemplate > \ source/${2}/$${modname}.rst.tmp && \ mv source/${2}/$${modname}.rst.tmp source/${2}/$${modname}.rst || exit 1; \ |