zephyr/doc/scripts
Ulf Magnusson 5c28f39e7f doc: genrest: Use a separate index page for all symbols
Add an option --separate-all-index that makes genrest.py generate a
separate index-all.rst index page that lists all symbols, instead of
listing all symbols in index.rst. index-all.rst is linked from
index.rst.

This was originally motivated by an external project where index.rst
becomes the top-level page, which runs into a Sphinx bottleneck with
sphinx_rtd_theme. See https://github.com/sphinx-doc/sphinx/issues/6909.

This turned out pretty nice after some feedback from Ruth Fuchss, so use
it for Zephyr too.

Also unclutter the generated documentation a bit by removing some
headings. This makes the navigation menu on the left nicer too.

Piggyback making genrest.py executable, which is handy when running it
manually.

Signed-off-by: Ulf Magnusson <Ulf.Magnusson@nordicsemi.no>
2019-12-11 12:32:30 -06:00
..
extract_content.py doc: extract_content.py: Suppress spurious pylint warning 2019-09-07 08:13:22 -04:00
fix_tex.py doc: fix_tex: Remove redundant 'return' 2019-03-26 07:47:20 -05:00
genrest.py doc: genrest: Use a separate index page for all symbols 2019-12-11 12:32:30 -06:00
restore_modification_times.py doc: fix incremental build by fixing doxygen output mtime 2019-02-13 06:58:52 -06:00