aboutsummaryrefslogtreecommitdiffstats
path: root/api-docs/source/index.rst
diff options
context:
space:
mode:
authorJoar Wandborg <git@wandborg.com>2012-04-01 01:21:20 +0200
committerJoar Wandborg <git@wandborg.com>2012-07-07 21:18:27 +0200
commitf4cc3a9d52c68aaf2a81b01af6dc78ce93ffb59e (patch)
tree1332a4566dbbd53866c957517af686ee900a6c07 /api-docs/source/index.rst
parent8588505c6fc4d163f7434152310d509fb863d780 (diff)
downloadmediagoblin-f4cc3a9d52c68aaf2a81b01af6dc78ce93ffb59e.tar.lz
mediagoblin-f4cc3a9d52c68aaf2a81b01af6dc78ce93ffb59e.tar.xz
mediagoblin-f4cc3a9d52c68aaf2a81b01af6dc78ce93ffb59e.zip
Added API documentation
- Applied the MediaGoblin docs theme to the API docs - Added api-docs/build to .gitignore - Configured api-docs/source/conf.py - Added /api-docs/source/mediagoblin* to .gitignore - Added apidoc directive to api docs Makefile, will build the API docs based on the source
Diffstat (limited to 'api-docs/source/index.rst')
-rw-r--r--api-docs/source/index.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/api-docs/source/index.rst b/api-docs/source/index.rst
new file mode 100644
index 00000000..531996bd
--- /dev/null
+++ b/api-docs/source/index.rst
@@ -0,0 +1,22 @@
+.. GNU MediaGoblin documentation master file, created by
+ sphinx-quickstart on Sun Apr 1 01:11:46 2012.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to GNU MediaGoblin's API documentation!
+===========================================
+
+See the :ref:`modindex` or this ToC:
+
+.. toctree::
+ :maxdepth: 10
+
+ mediagoblin
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+