Anastasia Klimchuk has uploaded this change for review. ( https://review.coreboot.org/c/flashrom/+/82196?usp=email )
Change subject: doc: Fix index files in Supported HW section ......................................................................
doc: Fix index files in Supported HW section
By default toctree in the index file displays full tree of docs with all the nested levels, and it's too much detail. Besides, left side menu displays the tree anyway, so duplication is not needed. Supported hardware section has the deepest nesting out of all other docs.
This patch changes high-level index files to only display flat list of next level subtree. On deeper level, full index is displayed.
Change-Id: Ia15e9766cce6f19be1e69fbb1236a327ae3d57b3 Signed-off-by: Anastasia Klimchuk aklm@flashrom.org --- M doc/supported_hw/index.rst M doc/supported_hw/supported_prog/index.rst 2 files changed, 11 insertions(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/flashrom refs/changes/96/82196/1
diff --git a/doc/supported_hw/index.rst b/doc/supported_hw/index.rst index 5552326..5b3305c 100644 --- a/doc/supported_hw/index.rst +++ b/doc/supported_hw/index.rst @@ -4,5 +4,8 @@
.. toctree:: :maxdepth: 3 + :hidden:
supported_prog/index + +* :doc:`supported_prog/index` diff --git a/doc/supported_hw/supported_prog/index.rst b/doc/supported_hw/supported_prog/index.rst index 9d71578..1dfabd5 100644 --- a/doc/supported_hw/supported_prog/index.rst +++ b/doc/supported_hw/supported_prog/index.rst @@ -3,5 +3,13 @@
.. toctree:: :maxdepth: 2 + :hidden:
serprog/index + +flashrom supports many different programmers, for the full list you can look into `programmer_table.c https://github.com/flashrom/flashrom/blob/main/programmer_table.c`_ +in the source tree. Some of the programmers have their own documentation pages, see below. + +Patches to add/update documentation, or migrate docs from `old wiki website https://wiki.flashrom.org/Supported_programmers`_ are very much appreciated. + +* :doc:`serprog/index`