From 76c7e70582b5540565482b474242b0ee17a769c9 Mon Sep 17 00:00:00 2001 From: whitequark Date: Wed, 1 Jul 2020 08:03:57 +0000 Subject: [PATCH] docs: add a crude approximation of intersphinx toctrees. This is a pretty awful hack. We could do this properly after one of the following issues is fixed: * sphinx-doc/sphinx#701 * sphinx-doc/sphinx#1836 --- docs/conf.py | 2 ++ docs/cover.rst | 8 ++++++++ docs/index.rst | 14 ++------------ 3 files changed, 12 insertions(+), 12 deletions(-) create mode 100644 docs/cover.rst diff --git a/docs/conf.py b/docs/conf.py index c311e9c..eedfa95 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -19,6 +19,8 @@ extensions = [ with open(".gitignore") as f: exclude_patterns = [line.strip() for line in f.readlines()] +master_doc = "cover" + intersphinx_mapping = {"python": ("https://docs.python.org/3", None)} todo_include_todos = True diff --git a/docs/cover.rst b/docs/cover.rst new file mode 100644 index 0000000..ced7431 --- /dev/null +++ b/docs/cover.rst @@ -0,0 +1,8 @@ +The nMigen documentation +######################## + +.. toctree:: + :maxdepth: 1 + + index + Board definitions diff --git a/docs/index.rst b/docs/index.rst index badd1f0..d1b0a0f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,5 +1,5 @@ -The nMigen core manual -###################### +Core language +############# .. warning:: @@ -12,13 +12,3 @@ The nMigen core manual install start lang - -Index -===== - -* :ref:`genindex` - -Search -====== - -* :ref:`search` -- 2.30.2