Skip to content

Commit 025f52d

Browse files
committed
organized api docs a bit [ci skip]
1 parent adb50ed commit 025f52d

File tree

4 files changed

+13
-7
lines changed

4 files changed

+13
-7
lines changed

docs/api.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
API and Source Reference
2+
------------------------
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
api/viz.rst
8+
api/probscale.rst
File renamed without changes.
File renamed without changes.

docs/index.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,8 @@ Simply importing ``probscale`` lets you use probability scales in your matplotli
6262
.. image:: /img/example.png
6363

6464

65-
Tutorial
66-
--------
65+
Tutorials
66+
=========
6767

6868
.. toctree::
6969
:maxdepth: 2
@@ -72,7 +72,7 @@ Tutorial
7272
tutorial/closer_look_at_viz.rst
7373

7474
Testing
75-
-------
75+
=======
7676

7777
It's easiest to run the tests from an interactive python session:
7878

@@ -83,15 +83,13 @@ It's easiest to run the tests from an interactive python session:
8383
import probscale
8484
probscale.test()
8585
86-
8786
API References
88-
--------------
87+
==============
8988

9089
.. toctree::
9190
:maxdepth: 2
9291

93-
viz.rst
94-
probscale.rst
92+
api.rst
9593

9694
Indices and tables
9795
==================

0 commit comments

Comments
 (0)