Skip to content

Commit 249ae4c

Browse files
committed
-
1 parent aa57772 commit 249ae4c

File tree

7 files changed

+24
-339
lines changed

7 files changed

+24
-339
lines changed

docs/misc/faq.txt

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

docs/misc/garlicsim_wx.txt

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

docs/misc/index.txt

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,5 @@ Miscellaneous topics
1313
.. toctree::
1414
:maxdepth: 1
1515

16-
faq
1716
mailing-lists
18-
19-
..
20-
garlicsim_wx
21-
17+

docs/ref/cruncher-api.txt

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

docs/ref/index.txt

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,20 @@
66

77
.. _ref-index:
88

9-
API Reference
10-
=============
9+
Reference to the Python Toolbox
10+
===============================
1111

12-
This section is still incomplete.
12+
(This section is still incomplete.)
13+
14+
This section contains reference-style documentation for the various modules in
15+
the Python Toolbox.
16+
17+
It focuses on giving technical explanations of the various
18+
functions and classes, *without* giving the motivation for using them or a
19+
bigger-picture view of why they were written and what they are good for. For
20+
those, :ref:`check out the topical guides <topics-index>`.
1321

1422
.. toctree::
1523
:maxdepth: 1
1624

17-
simpack-api
18-
garlicsim_wx_general_misc/index
19-
20-
21-
..
22-
cruncher-api
2325

docs/ref/simpack-api.txt

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

docs/topics/index.txt

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,24 +6,18 @@
66

77
.. _topics-index:
88

9-
All about Garlicsim
10-
===================
9+
Topical guides to the Python Toolbox
10+
====================================
1111

12-
Introductions to all the key parts of GarlicSim you'll need to know:
12+
(This section is still incomplete.)
1313

14-
.. toctree::
15-
:maxdepth: 1
14+
These are topical guides about the various modules in the Python Toolbox.
1615

17-
what-is-garlicsim
18-
time-tree
19-
step-functions
20-
step-profiles
21-
22-
..
23-
synchronous-crunching
24-
asynchronous-crunching
25-
persistent
26-
history-dependent-simulations
27-
28-
29-
This section is still incomplete.
16+
It focuses on giving the motivation for each module in the Python Toolbox,
17+
explaining what it's good for and the basics of using it.
18+
19+
For a more complete and thorough documentation including more technical
20+
detalis, :ref:`check out the reference documentation <ref-index>`.
21+
22+
.. toctree::
23+
:maxdepth: 1

0 commit comments

Comments
 (0)