Skip to content

Commit abd04f1

Browse files
committed
DOC: add auto-generated API docs
They are not pretty, but better than nothing
1 parent dc41003 commit abd04f1

File tree

3 files changed

+24
-2
lines changed

3 files changed

+24
-2
lines changed

docs/source/api/index.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
***
2+
API
3+
***
4+
5+
6+
7+
Containers
8+
==========
9+
10+
.. automodule:: data_prototype.containers
11+
:members:
12+
:undoc-members:
13+
14+
15+
16+
Wrappers
17+
========
18+
19+
.. automodule:: data_prototype.wrappers
20+
:members:

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757

5858

5959
# Generate the API documentation when building
60-
autosummary_generate = True
60+
autosummary_generate = False
6161
numpydoc_show_class_members = False
6262

6363
is_release_build = False

docs/source/index.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,16 @@ This is prototype development for the next generation of data structures for
1010
Matplotlib. This is the version "to throw away". Everything in this
1111
repository should be considered experimental and used at you own risk.
1212

13+
Source : [tacaswell/data-prototype](https://github.com/tacaswell/data-prototype) (for now)
14+
1315
Examples
1416
--------
1517

1618
.. toctree::
1719
:maxdepth: 2
1820

1921
gallery/index.rst
20-
22+
api/index.rst
2123

2224
Backmatter
2325
----------

0 commit comments

Comments
 (0)