Skip to content

Commit 696b897

Browse files
committed
Updated API docs structure.
1 parent 6f01b25 commit 696b897

33 files changed

Lines changed: 245 additions & 296 deletions

api/__init__.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
"""
2-
The Deis application programming interface (API).
2+
The **api** Django app presents a RESTful web API for interacting with the **deis** system.
3+
4+
:py:mod:`api.fields`
35
"""

docs/api/api.fields.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
==========
2+
api.fields
3+
==========
4+
5+
.. contents::
6+
:local:
7+
.. currentmodule:: api.fields
8+
9+
.. automodule:: api.fields
10+
:members:
11+
:undoc-members:

docs/api/api.management.commands.rst

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

docs/api/api.management.rst

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

docs/api/api.migrations.rst

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

docs/api/api.models.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
==========
2+
api.models
3+
==========
4+
5+
.. contents::
6+
:local:
7+
.. currentmodule:: api.models
8+
9+
.. automodule:: api.models
10+
:members:
11+
:undoc-members:

docs/api/api.routers.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
===========
2+
api.routers
3+
===========
4+
5+
.. contents::
6+
:local:
7+
.. currentmodule:: api.routers
8+
9+
.. automodule:: api.routers
10+
:members:
11+
:undoc-members:

docs/api/api.serializers.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
===============
2+
api.serializers
3+
===============
4+
5+
.. contents::
6+
:local:
7+
.. currentmodule:: api.serializers
8+
9+
.. automodule:: api.serializers
10+
:members:
11+
:undoc-members:

docs/api/api.tests.rst

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

docs/api/api.urls.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
========
2+
api.urls
3+
========
4+
5+
.. contents::
6+
:local:
7+
.. currentmodule:: api.urls
8+
9+
.. automodule:: api.urls
10+
:members:
11+
:undoc-members:

0 commit comments

Comments
 (0)