Skip to content

Commit 3449a9d

Browse files
committed
Merge pull request #3953 from mboersma/update-sphinx-autodocs
docs(reference): add missing packages to autodoc
2 parents fa17b49 + bae8037 commit 3449a9d

6 files changed

Lines changed: 46 additions & 3 deletions

File tree

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:description: Python API Reference for the Deis api.authentication module
2+
3+
api.authentication
4+
------------------
5+
.. contents::
6+
:local:
7+
.. automodule:: api.authentication
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:description: Python API Reference for the Deis api.middleware module
2+
3+
api.middleware
4+
--------------
5+
.. contents::
6+
:local:
7+
.. automodule:: api.middleware
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:description: Python API Reference for the Deis api.permissions module
2+
3+
api.permissions
4+
---------------
5+
.. contents::
6+
:local:
7+
.. automodule:: api.permissions
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
:description: Python API Reference for the Deis api.viewsets module
2+
3+
api.viewsets
4+
------------
5+
.. contents::
6+
:local:
7+
.. automodule:: api.viewsets

docs/reference/server/index.rst

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,17 @@ Server Reference
99

1010
.. toctree::
1111

12-
1312
api.admin
13+
api.authentication
1414
api.fields
15+
api.middleware
1516
api.models
17+
api.permissions
1618
api.routers
1719
api.serializers
1820
api.utils
1921
api.views
22+
api.viewsets
2023
registry
2124
scheduler
2225
web

docs/reference/server/scheduler.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
scheduler
44
=========
55

6+
scheduler.chaos
7+
---------------
8+
.. contents::
9+
:local:
10+
.. automodule:: scheduler.chaos
11+
612
scheduler.fleet
713
---------------
814
.. contents::
@@ -15,8 +21,14 @@ scheduler.mock
1521
:local:
1622
.. automodule:: scheduler.mock
1723

18-
scheduler.chaos
24+
scheduler.states
25+
----------------
26+
.. contents::
27+
:local:
28+
.. automodule:: scheduler.states
29+
30+
scheduler.swarm
1931
---------------
2032
.. contents::
2133
:local:
22-
.. automodule:: scheduler.chaos
34+
.. automodule:: scheduler.swarm

0 commit comments

Comments
 (0)