Fix issue #868, index missing from documentation

The index disappeared when we moved to the readthedocs theme. To fix it I added a dummy file genindex.rst and added genindex.rst to the index.rst file. This is clearly a hack but it works.
pywbem · Jan 15, 2021 · a88d98c · a88d98c
1 parent 5c69cc3
commit a88d98c
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 0 deletions.
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -44,6 +44,9 @@ Released: not yet
 * Mitigated the coveralls HTTP status 422 by pinning coveralls-python to
   <3.0.0.
 
+* Fix issue where documentation index disappeared when we changed the
+  documentation theme (see issue #868)
+
 **Enhancements:**
 
 * Add new option to class find command (--summary) to display a summary of

diff --git a/docs/genindex.rst b/docs/genindex.rst
@@ -0,0 +1,6 @@
+Document Index
+##############
+
+.. This is effectively an empty file that is required to generate
+.. the document index. It is overlayed in html with the generated
+.. index
diff --git a/docs/index.rst b/docs/index.rst
@@ -18,3 +18,5 @@ The pywbemtools github page is: `https://github.com/pywbem/pywbemtools <https://
    development.rst
    appendix.rst
    changes.rst
+   genindex.rst
+.. The genindex.rst and a corresponding file required to include index