Skip to content

Commit 146457a

Browse files
authored
Docs: restructure (#573)
The idea here is to make the docs have a more flat design that exposes more pages from the main index.
1 parent 31f743a commit 146457a

File tree

5 files changed

+23
-37
lines changed

5 files changed

+23
-37
lines changed

docs/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
77
SPHINXPROJ = ReadtheDocsSphinxTheme
88
SOURCEDIR = .
9-
BUILDDIR = _build
9+
BUILDDIR = build
1010

1111
# Put it first so that "make" without argument is like "make help".
1212
help:

docs/demo/api.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@
1010
:private-members:
1111
:special-members:
1212

13+
Generated Index
14+
===============
15+
16+
Part of the sphinx build process in generate and index file: :ref:`genindex`.
17+
1318

1419
Optional parameter args
1520
=======================

docs/demo/index.rst

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/index.rst

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,28 @@
11
.. include:: ../README.rst
22

3-
Content
4-
=======
5-
63
.. toctree::
7-
:caption: Theme
4+
:caption: Theme Documentation
85
:maxdepth: 2
96

107
installing
118
configuring
129
changelog
1310
contributing
1411

12+
1513
.. toctree::
16-
:caption: Demo
17-
:maxdepth: 2
14+
:maxdepth: 2
15+
:numbered:
16+
:caption: Demo Documents
17+
18+
demo/structure
19+
demo/demo
20+
demo/lists_tables
21+
demo/api
22+
23+
.. toctree::
24+
:maxdepth: 3
25+
:numbered:
26+
:caption: This is an incredibly long caption for a long menu
1827

19-
demo/index
28+
demo/long

docs/make.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ if "%SPHINXBUILD%" == "" (
1010
set SPHINXOPTS=
1111
set SPHINXBUILD=sphinx-build
1212
set SOURCEDIR=.
13-
set BUILDDIR=_build
13+
set BUILDDIR=build
1414
set SPHINXPROJ=ReadtheDocsSphinxTheme
1515

1616
if "%1" == "" goto help

0 commit comments

Comments
 (0)