Skip to content

Commit 25a025f

Browse files
documentation boilerplate
1 parent f3929e6 commit 25a025f

4 files changed

Lines changed: 19 additions & 8 deletions

File tree

docs/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
build

docs/source/advanced.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Advanced Use Cases
2+
==================
3+

docs/source/index.rst

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,20 @@
33
You can adapt this file completely to your liking, but it should at least
44
contain the root `toctree` directive.
55
6-
tasktronaut documentation
7-
=========================
8-
9-
Add your content using ``reStructuredText`` syntax. See the
10-
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
11-
documentation for details.
12-
6+
``tasktronaut`` Documentation
7+
=============================
138

149
.. toctree::
15-
:maxdepth: 2
10+
:maxdepth: 1
1611
:caption: Contents:
1712

13+
user_guide
14+
advanced
15+
api/modules
16+
17+
Indices and tables
18+
==================
19+
20+
* :ref:`genindex`
21+
* :ref:`modindex`
22+
* :ref:`search`

docs/source/user_guide.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
User Guide
2+
==========

0 commit comments

Comments
 (0)