From 0d8f14d3e289bbedb4017bf4633bc0263cf610bc Mon Sep 17 00:00:00 2001 From: Oliver Walters <oliver.henry.walters@gmail.com> Date: Sun, 28 Apr 2019 00:20:27 +1000 Subject: [PATCH] Add index and modindex to sidebar - https://stackoverflow.com/questions/25243482/how-to-add-sphinx-generated-index-to-the-sidebar-when-using-read-the-docs-theme --- docs/conf.py | 2 ++ docs/templates/layout.html | 7 +++++++ 2 files changed, 9 insertions(+) create mode 100644 docs/templates/layout.html diff --git a/docs/conf.py b/docs/conf.py index 127f6abe22..3efd301b47 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -68,7 +68,9 @@ autoapi_ignore = [ # Add any paths that contain templates here, relative to this directory. autoapi_template_dir = 'templates' +autoapi_root = 'api' +templates_path = ['templates'] # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. diff --git a/docs/templates/layout.html b/docs/templates/layout.html new file mode 100644 index 0000000000..a778e0fdb3 --- /dev/null +++ b/docs/templates/layout.html @@ -0,0 +1,7 @@ +{% extends "!layout.html" %} + + {% block menu %} + {{ super() }} + <a href="genindex.html">Index</a> + <a href="py-modindex.html">Module Index</a> + {% endblock %} \ No newline at end of file