Docs: restructure (#573)

The idea here is to make the docs have a more flat design that exposes more pages from the main index.
This commit is contained in:
Aaron Carlisle 2018-03-01 10:15:53 -05:00 committed by GitHub
parent 31f743ae93
commit 146457a6c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 24 additions and 38 deletions

View File

@ -6,7 +6,7 @@ SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = ReadtheDocsSphinxTheme
SOURCEDIR = .
BUILDDIR = _build
BUILDDIR = build
# Put it first so that "make" without argument is like "make help".
help:

View File

@ -10,6 +10,11 @@
:private-members:
:special-members:
Generated Index
===============
Part of the sphinx build process in generate and index file: :ref:`genindex`.
Optional parameter args
=======================

View File

@ -1,28 +0,0 @@
Read the Docs Theme Demo
************************
These documents are used to test and stress test the Read the Docs Theme.
:Last Reviewed: 2017-3-15
Contents
========
.. toctree::
:maxdepth: 3
:numbered:
:caption: Syntax Constructs
structure
demo
lists_tables
api
.. toctree::
:maxdepth: 3
:numbered:
:caption: This is an incredibly long caption for a long menu
long
You can also read the :ref:`genindex`

View File

@ -1,10 +1,7 @@
.. include:: ../README.rst
Content
=======
.. toctree::
:caption: Theme
:caption: Theme Documentation
:maxdepth: 2
installing
@ -12,8 +9,20 @@ Content
changelog
contributing
.. toctree::
:caption: Demo
:maxdepth: 2
demo/index
.. toctree::
:maxdepth: 2
:numbered:
:caption: Demo Documents
demo/structure
demo/demo
demo/lists_tables
demo/api
.. toctree::
:maxdepth: 3
:numbered:
:caption: This is an incredibly long caption for a long menu
demo/long

View File

@ -10,7 +10,7 @@ if "%SPHINXBUILD%" == "" (
set SPHINXOPTS=
set SPHINXBUILD=sphinx-build
set SOURCEDIR=.
set BUILDDIR=_build
set BUILDDIR=build
set SPHINXPROJ=ReadtheDocsSphinxTheme
if "%1" == "" goto help