summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoss Barnowski <rossbar@berkeley.edu>2021-02-26 13:00:14 -0800
committerRoss Barnowski <rossbar@berkeley.edu>2021-02-26 13:00:14 -0800
commit678919107f29a1da946d2c2ca00d712b830a5753 (patch)
treed5bdb396be95cb8bcbef69389cf1177bfc3daaa7
parenta14c41264855e44ebd6187d7541b5b8d59bb32cb (diff)
downloadnumpy-678919107f29a1da946d2c2ca00d712b830a5753.tar.gz
DOC: mv meta landing page to index.rst.
The current master_doc is really only used to specify the toctree to set up the navbar in the pydata-sphinx-theme. By renaming to index.rst the navbar config is preserved and the links back to the main page point to the original landing page rather than the contents page, which was mostly empty.
-rw-r--r--doc/source/conf.py2
-rw-r--r--doc/source/index.rst (renamed from doc/source/contents.rst)1
2 files changed, 2 insertions, 1 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 238f8588a..7eb96eb22 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -94,7 +94,7 @@ templates_path = ['_templates']
# The suffix of source filenames.
source_suffix = '.rst'
-master_doc = 'contents'
+master_doc = 'index'
# General substitutions.
project = 'NumPy'
diff --git a/doc/source/contents.rst b/doc/source/index.rst
index 5d4e12097..21dec00fe 100644
--- a/doc/source/contents.rst
+++ b/doc/source/index.rst
@@ -6,6 +6,7 @@ NumPy Documentation
.. toctree::
:maxdepth: 1
+ :hidden:
User Guide <user/index>
API reference <reference/index>