From ae0d14df60914b5eb656ee06367acc41394796f9 Mon Sep 17 00:00:00 2001 From: "Dustin C. Hatch" Date: Tue, 5 Apr 2011 23:40:33 -0500 Subject: [PATCH] Started API reference documentation --- doc/index.rst | 1 + doc/reference/app.rst | 6 ++++++ doc/reference/auth/decorators.rst | 6 ++++++ doc/reference/auth/index.rst | 11 +++++++++++ doc/reference/auth/permissions.rst | 6 ++++++ doc/reference/controllers.rst | 6 ++++++ doc/reference/dispatch/index.rst | 11 +++++++++++ doc/reference/dispatch/routing.rst | 6 ++++++ doc/reference/dispatch/traversal.rst | 6 ++++++ doc/reference/index.rst | 10 ++++++++++ doc/reference/util.rst | 6 ++++++ 11 files changed, 75 insertions(+) create mode 100644 doc/reference/app.rst create mode 100644 doc/reference/auth/decorators.rst create mode 100644 doc/reference/auth/index.rst create mode 100644 doc/reference/auth/permissions.rst create mode 100644 doc/reference/controllers.rst create mode 100644 doc/reference/dispatch/index.rst create mode 100644 doc/reference/dispatch/routing.rst create mode 100644 doc/reference/dispatch/traversal.rst create mode 100644 doc/reference/index.rst create mode 100644 doc/reference/util.rst diff --git a/doc/index.rst b/doc/index.rst index 7b35866..95287db 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -14,6 +14,7 @@ Contents: :maxdepth: 2 rationale + reference/index Indices and tables ================== diff --git a/doc/reference/app.rst b/doc/reference/app.rst new file mode 100644 index 0000000..fc3d44e --- /dev/null +++ b/doc/reference/app.rst @@ -0,0 +1,6 @@ +========= +milla.app +========= + +.. automodule:: milla.app + :members: diff --git a/doc/reference/auth/decorators.rst b/doc/reference/auth/decorators.rst new file mode 100644 index 0000000..a8c92ad --- /dev/null +++ b/doc/reference/auth/decorators.rst @@ -0,0 +1,6 @@ +===================== +milla.auth.decorators +===================== + +.. automodule:: milla.auth.decorators + :members: diff --git a/doc/reference/auth/index.rst b/doc/reference/auth/index.rst new file mode 100644 index 0000000..97bf9d4 --- /dev/null +++ b/doc/reference/auth/index.rst @@ -0,0 +1,11 @@ +========== +milla.auth +========== + +.. toctree:: + :glob: + + * + +.. automodule:: milla.auth + :members: diff --git a/doc/reference/auth/permissions.rst b/doc/reference/auth/permissions.rst new file mode 100644 index 0000000..dfb74e2 --- /dev/null +++ b/doc/reference/auth/permissions.rst @@ -0,0 +1,6 @@ +====================== +milla.auth.permissions +====================== + +.. automodule:: milla.auth.permissions + :members: diff --git a/doc/reference/controllers.rst b/doc/reference/controllers.rst new file mode 100644 index 0000000..0d5481f --- /dev/null +++ b/doc/reference/controllers.rst @@ -0,0 +1,6 @@ +================= +milla.controllers +================= + +.. automodule:: milla.controllers + :members: diff --git a/doc/reference/dispatch/index.rst b/doc/reference/dispatch/index.rst new file mode 100644 index 0000000..7667631 --- /dev/null +++ b/doc/reference/dispatch/index.rst @@ -0,0 +1,11 @@ +============== +milla.dispatch +============== + +.. toctree:: + :glob: + + * + +.. automodule:: milla.dispatch + :members: diff --git a/doc/reference/dispatch/routing.rst b/doc/reference/dispatch/routing.rst new file mode 100644 index 0000000..45bf3a7 --- /dev/null +++ b/doc/reference/dispatch/routing.rst @@ -0,0 +1,6 @@ +====================== +milla.dispatch.routing +====================== + +.. automodule:: milla.dispatch.routing + :members: diff --git a/doc/reference/dispatch/traversal.rst b/doc/reference/dispatch/traversal.rst new file mode 100644 index 0000000..f9a5f9b --- /dev/null +++ b/doc/reference/dispatch/traversal.rst @@ -0,0 +1,6 @@ +======================== +milla.dispatch.traversal +======================== + +.. automodule:: milla.dispatch.traversal + :members: diff --git a/doc/reference/index.rst b/doc/reference/index.rst new file mode 100644 index 0000000..dfe3903 --- /dev/null +++ b/doc/reference/index.rst @@ -0,0 +1,10 @@ +============= +API Reference +============= + +.. toctree:: + :glob: + + auth/index + dispatch/index + * diff --git a/doc/reference/util.rst b/doc/reference/util.rst new file mode 100644 index 0000000..01cbeb7 --- /dev/null +++ b/doc/reference/util.rst @@ -0,0 +1,6 @@ +========== +milla.util +========== + +.. automodule:: milla.util + :members: