Skip to content

Commit edf978a

Browse files
authored
move contents.rst into index.rst and update refs
1 parent ffe9493 commit edf978a

3 files changed

Lines changed: 36 additions & 41 deletions

File tree

docs/source/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@
208208
# (source start file, target name, title,
209209
# author, documentclass [howto, manual, or own class]).
210210
latex_documents = [
211-
('contents', 'AABBTree.tex', 'AABBTree Documentation',
211+
('index', 'AABBTree.tex', 'AABBTree Documentation',
212212
'Kenneth Hart', 'howto'),
213213
]
214214

@@ -218,7 +218,7 @@
218218
# One entry per manual page. List of tuples
219219
# (source start file, name, description, authors, manual section).
220220
man_pages = [
221-
('contents', 'AABBTree', 'AABBTree Documentation',
221+
('index', 'AABBTree', 'AABBTree Documentation',
222222
[author], 1)
223223
]
224224

@@ -229,7 +229,7 @@
229229
# (source start file, target name, title, author,
230230
# dir menu entry, description, category)
231231
texinfo_documents = [
232-
('contents', 'AABBTree', 'AABBTree Documentation',
232+
('index', 'AABBTree', 'AABBTree Documentation',
233233
author, 'AABBTree',
234234
'Pure Python implementation of d-dimensional AABB tree.',
235235
'Miscellaneous'),

docs/source/contents.rst

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

docs/source/index.rst

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,34 @@
1-
=================
2-
Introduction
3-
=================
1+
.. AABBTree documentation master file.
42
5-
Hello World!
3+
.. include:: ../../README.rst
4+
:end-before: .. begin-badges
5+
6+
.. Introduction
7+
.. include:: ../../README.rst
8+
:start-after: .. begin-introduction
9+
:end-before: .. end-introduction
10+
11+
.. Image of AABB Tree
12+
.. figure:: _static/diagram.png
13+
:alt: AABB Tree
14+
:align: center
15+
16+
Left: An AABB tree, leaves numbered by insertion order.
17+
Right: The AABBs and their bounding boxes.
18+
19+
20+
.. Installation and example sections
21+
.. include:: ../../README.rst
22+
:start-after: .. begin-installation
23+
:end-before: .. begin-documentation
24+
25+
.. API
26+
.. include:: aabbtree.rst
27+
28+
.. Contributing and license
29+
.. include:: ../../README.rst
30+
:start-after: .. end-documentation
31+
32+
.. admonition:: License
33+
34+
.. include:: ../../LICENSE.rst

0 commit comments

Comments
 (0)