Fixing inconsistency between manual contents and navigation sidebar in the read the docs theme <Ravenbrook/mps#166 (comment)>

Author: rptb1

mps/manual/source/_templates/layout.html

@@ -0,0 +1,32 @@
+{# manual/source/_templates/layout.html -- add index to manual sidebar.
+ #
+ # See https://stackoverflow.com/a/37843854 .
+ #}
+
+{% extends "!layout.html" %}
+
+  {% block menu %}
+    {{ super() }}
+
+<p class="caption" role="heading">
+  <span class="caption-text">Indices and tables</span>
+</p>
+
+<ul>
+
+  <li class="toctree-11">
+
+    <a class="reference internal" href="{{pathto('genindex.html', 1)}}">Index</a>
+
+    {# Module index and search page aren't used in the MPS manual but
+       might be in future.  This is how they might be added. #}
+
+    {# <a class="reference internal" href="{{pathto('modindex.html', 1)}}">Module Index</a> #}
+
+    {# <a class="reference internal" href="{{pathto('search.html', 1)}}">Search Page</a> #}
+
+  </li>
+
+</ul>
+
+  {% endblock %}

mps/manual/source/index.rst

@@ -1,7 +1,5 @@
-Memory Pool System
-##################
-
 .. toctree::
+    :caption: Memory Pool System
     :maxdepth: 2
 
     guide/index
@@ -10,11 +8,8 @@ Memory Pool System
     design/index
     design/old
 
-
-Appendices
-##########
-
 .. toctree::
+    :caption: Appendices
     :maxdepth: 1
 
     bib
@@ -25,14 +20,15 @@ Appendices
     contributing
     release
 
-* :ref:`genindex`
-
-
 .. toctree::
-    :hidden:
+    :caption: Memory Management Reference
+    :maxdepth: 2
 
     mmref/index
     mmref-index
     mmref/faq
     mmref-copyright
     mmref/credit
+
+* :ref:`genindex`
+