From 3db5b234d13ab0c6b4dc447633bd2f26055de859 Mon Sep 17 00:00:00 2001 From: Mike Hearn Date: Tue, 8 Mar 2016 18:32:13 +0100 Subject: [PATCH] Docs: add link from docsite to api docs --- docs/source/_templates/layout.html | 6 ++++++ docs/source/conf.py | 5 ++--- docs/source/index.rst | 2 ++ 3 files changed, 10 insertions(+), 3 deletions(-) create mode 100644 docs/source/_templates/layout.html diff --git a/docs/source/_templates/layout.html b/docs/source/_templates/layout.html new file mode 100644 index 0000000000..69861af39d --- /dev/null +++ b/docs/source/_templates/layout.html @@ -0,0 +1,6 @@ +{% extends "!layout.html" %} +{% block sidebartitle %} +{{ super() }} +
+API reference +{% endblock %} diff --git a/docs/source/conf.py b/docs/source/conf.py index b1e2bc5691..9b9745b165 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -115,6 +115,8 @@ html_theme = "sphinx_rtd_theme" html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +html_add_permalinks = True + # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. @@ -159,9 +161,6 @@ html_style = 'css/custom.css' # typographically correct entities. #html_use_smartypants = True -# Custom sidebar templates, maps document names to template names. -#html_sidebars = {} - # Additional templates that should be rendered to pages, maps page names to # template names. #html_additional_pages = {} diff --git a/docs/source/index.rst b/docs/source/index.rst index 7d3675f556..473fa96175 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -16,6 +16,8 @@ prove or disprove the following hypothesis: *is sufficiently powerful to justify the creation of a new platform implementation.* + + Read on to learn: