File tree Expand file tree Collapse file tree 4 files changed +20
-39
lines changed Expand file tree Collapse file tree 4 files changed +20
-39
lines changed Original file line number Diff line number Diff line change 11API Reference
22=============
33
4- Seeders
5- -------
64
7- .. automodule :: sqlalchemyseed.seeder
8- :members:
9- :undoc-members:
5+ .. toctree ::
6+ :maxdepth: 2
107
11- Loaders
12- -------
13-
14- .. automodule :: sqlalchemyseed.loader
15- :members:
16-
17- Validators
18- ----------
19-
20- .. automodule :: sqlalchemyseed.validator
21- :members:
22- :undoc-members:
23-
24- Exceptions
25- ----------
26-
27- .. automodule :: sqlalchemyseed.errors
28- :members:
29-
30- Utilities
31- ---------
32-
33- .. automodule :: sqlalchemyseed.util
34- :members:
35- :undoc-members:
8+ api/sqlalchemyseed/index
Original file line number Diff line number Diff line change 5353# relative to this directory. They are copied after the builtin static files,
5454# so a file named "default.css" will overwrite the builtin "default.css".
5555html_static_path = ['_static' ]
56+
57+ # autoapi.extension configuration
58+ extensions .append ('autoapi.extension' )
59+
60+ autoapi_type = 'python'
61+ autoapi_dirs = ['../src' ]
62+ autoapi_options = ['members' , 'undoc-members' , 'show-inheritance' ]
63+ autoapi_add_toctree_entry = False
64+ autoapi_generate_api_docs = True
65+ autoapi_root = 'api'
66+ autoapi_file_patterns = ['*.py' ]
67+ autoapi_member_order = 'groupwise'
Original file line number Diff line number Diff line change @@ -31,15 +31,10 @@ execute this command to install necessary dependencies
3131 Dependencies
3232------------
3333
34- Required dependencies:
35-
36- - SQAlchemy>=1.4.0
37-
38- Optional dependencies:
39-
40- - yaml
41-
42- - PyYAML>=5.4.0
34+ - Required dependencies:
35+ - SQAlchemy>=1.4.0
36+ - Optional dependencies:
37+ - yaml: PyYAML>=5.4.0
4338
4439Quickstart
4540----------
Original file line number Diff line number Diff line change 55
66# Extentions
77sphinx-copybutton
8+ sphinx-autoapi
89
910# Others
1011sphinx-autobuild
You can’t perform that action at this time.
0 commit comments