From 6b45fc55173ae6723762935aa34341bcbbc1663a Mon Sep 17 00:00:00 2001 From: "David B. Kinder" Date: Thu, 5 Nov 2020 08:44:02 -0800 Subject: [PATCH] doc: add sphinx-generated index to leftnav Sphinx generates a full-site index (headings, terms, function names, etc.) but we haven't been linking to it. This is a tricky way to get the site index added to the left nav that appears to work, by creating a genindex.rst that we can link to in the site toctree so it shows up in the leftnav, but the generated genindex.html for the dummy genindex.rst will be overwritten by the sphinx created genindex.html with the full-site index. Signed-off-by: David B. Kinder --- doc/genindex.rst | 8 ++++++++ doc/index.rst | 1 + 2 files changed, 9 insertions(+) create mode 100644 doc/genindex.rst diff --git a/doc/genindex.rst b/doc/genindex.rst new file mode 100644 index 000000000..7fb301504 --- /dev/null +++ b/doc/genindex.rst @@ -0,0 +1,8 @@ +.. Place holder Index. The sphinx-generated genindex.html will overwrite + this placeholder when the website is created, but his file will give us + something we can add to the TOC. Technically this isn't advised, but + works. + +Index +##### + diff --git a/doc/index.rst b/doc/index.rst index 6e61b96a2..b6819e03c 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -84,6 +84,7 @@ license. asa FAQ glossary + genindex .. _BSD 3-clause license: https://github.com/projectacrn/acrn-hypervisor/blob/master/LICENSE