OrgACRN
/
acrn-hypervisor
mirror of https://github.com/projectacrn/acrn-hypervisor.git
1
0
Fork 0
Code Issues Releases Wiki Activity

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 <david.b.kinder@intel.com>
This commit is contained in:
David B. Kinder 2020-11-05 08:44:02 -08:00 committed by David Kinder
parent 73f21a41ad
commit 6b45fc5517
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/genindex.rst Normal file
View File

@ -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
#####

1
doc/index.rst
View File

@ -84,6 +84,7 @@ license.
asa asa
FAQ <faq> FAQ <faq>
glossary glossary
genindex
.. _BSD 3-clause license: .. _BSD 3-clause license:
https://github.com/projectacrn/acrn-hypervisor/blob/master/LICENSE https://github.com/projectacrn/acrn-hypervisor/blob/master/LICENSE