Added stub .rst files for most of the API; modified conf.py so Sphinx can setup the Django environment before importing; cleaned up and formatted existing .rst docs a little

Author: wapcaplet

docs/api/bookmarks.rst

@@ -0,0 +1,24 @@
+:mod:`bookmarks`
+================
+
+:mod:`bookmarks.admin`
+----------------------------------
+.. automodule:: bookmarks.admin
+    :members:
+
+:mod:`bookmarks.models`
+----------------------------------
+.. automodule:: bookmarks.models
+    :members:
+
+:mod:`bookmarks.urls`
+----------------------------------
+.. automodule:: bookmarks.urls
+    :members:
+
+:mod:`bookmarks.views`
+----------------------------------
+.. automodule:: bookmarks.views
+    :members:
+
+

docs/api/builds.rst

@@ -0,0 +1,23 @@
+:mod:`builds`
+=============
+
+:mod:`builds.admin`
+----------------------------------
+.. automodule:: builds.admin
+    :members:
+
+:mod:`builds.models`
+----------------------------------
+.. automodule:: builds.models
+    :members:
+
+:mod:`builds.urls`
+----------------------------------
+.. automodule:: builds.urls
+    :members:
+
+:mod:`builds.views`
+----------------------------------
+.. automodule:: builds.views
+    :members:
+

docs/api/core.rst

@@ -0,0 +1,33 @@
+:mod:`core`
+===========
+
+:mod:`core.admin`
+----------------------------------
+.. automodule:: core.admin
+    :members:
+
+:mod:`core.forms`
+----------------------------------
+.. automodule:: core.forms
+    :members:
+
+:mod:`core.middleware`
+----------------------------------
+.. automodule:: core.middleware
+    :members:
+
+:mod:`core.models`
+----------------------------------
+.. automodule:: core.models
+    :members:
+
+:mod:`core.search_sites`
+----------------------------------
+.. automodule:: core.search_sites
+    :members:
+
+:mod:`core.views`
+----------------------------------
+.. automodule:: core.views
+    :members:
+

docs/api/index.rst

@@ -0,0 +1,11 @@
+API
+===
+
+.. toctree::
+
+    bookmarks
+    builds
+    core
+    projects
+    watching
+

docs/api/projects.rst

@@ -0,0 +1,38 @@
+:mod:`projects`
+===============
+
+:mod:`projects.admin`
+----------------------------------
+.. automodule:: projects.admin
+    :members:
+
+:mod:`projects.constants`
+----------------------------------
+.. automodule:: projects.constants
+    :members:
+
+:mod:`projects.forms`
+----------------------------------
+.. automodule:: projects.forms
+    :members:
+
+:mod:`projects.models`
+----------------------------------
+.. automodule:: projects.models
+    :members:
+
+:mod:`projects.search_indexes`
+----------------------------------
+.. automodule:: projects.search_indexes
+    :members:
+
+:mod:`projects.tasks`
+----------------------------------
+.. automodule:: projects.tasks
+    :members:
+
+:mod:`projects.utils`
+----------------------------------
+.. automodule:: projects.utils
+    :members:
+

docs/api/watching.rst

@@ -0,0 +1,24 @@
+:mod:`watching`
+===============
+
+:mod:`watching.admin`
+----------------------------------
+.. automodule:: watching.admin
+    :members:
+
+:mod:`watching.models`
+----------------------------------
+.. automodule:: watching.models
+    :members:
+
+:mod:`watching.urls`
+----------------------------------
+.. automodule:: watching.urls
+    :members:
+
+:mod:`watching.views`
+----------------------------------
+.. automodule:: watching.views
+    :members:
+
+

docs/conf.py

@@ -16,7 +16,12 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath('..'))
+
+# Set up the Django environment so Sphinx can autodocument its modules
+import settings.sqlite
+from django.core.management import setup_environ
+setup_environ(settings.sqlite)
 
 # -- General configuration -----------------------------------------------------
 
@@ -25,7 +30,7 @@
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = []
+extensions = ['sphinx.ext.autodoc']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -67,7 +72,7 @@
 exclude_patterns = ['_build']
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+default_role = 'obj'
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
 #add_function_parentheses = True

docs/index.rst

@@ -7,7 +7,7 @@ Welcome to Read The Docs's
 ==========================
 
 This is a site devoted to the hosting of documentation for the open source
-community. It currently supports sphinx documentation, written in 
+community. It currently supports sphinx documentation, written in
 `reStructuredText format <http://sphinx.pocoo.org/rest.html>`_.  We can pull
 your existing docs if they're hosted on GitHub or Bitbucket, or you can
 create documentation using our reSt editor.
@@ -23,7 +23,10 @@ documentation!  I hope you like it.
 Contents:
 
 .. toctree::
-   :maxdepth: 2
-   :glob:
+    :maxdepth: 2
+
+    install
+    support
+    webhooks
+    api/index
 
-   *

docs/install.rst

@@ -87,7 +87,8 @@ whenever you commit to your repo, effectively letting you 'set it and forget it'
 Caveats
 -------
 
-We are auto-importing and generating conf.py files, so projects with special
+We are auto-importing and generating ``conf.py`` files, so projects with special
 extensions, themes, or templates won't work correctly. This is because of the
-possible of code execution within the python files. We are planing to support
-popular themes and white list projects that we trust to have these abilities.
+possibility of code execution within the python files. We are planning to support
+popular themes and white list users that we trust to have these abilities.
+

docs/support.rst

@@ -1,7 +1,12 @@
 Getting Help
 =============
 
-The easiest way to get help with the project is to join the #rtd project on Freenode. We hang out there and you can get real-time help with your projects. The other good way is to open an issue on Github.
-
+The easiest way to get help with the project is to join the ``#rtd`` channel on
+Freenode_. We hang out there and you can get real-time help with your projects.
+The other good way is to open an issue on Github_.
 
 The email at [email protected] is also available for support.
+
+.. _Freenode: irc://freenode.net/
+.. _Github: http://github.com/rtfd/readthedocs.org/issues
+

docs/webhooks.rst

@@ -1,8 +1,16 @@
 Webhooks
 ========
 
-Web hooks are pretty amazing, and help to turn the web into a push instead of pull platform. We have support for hitting a URL whenever you commit to your project and we will try and rebuild your docs. This only rebuilds them if something has changed, so it is cheap on the server side. 
+Web hooks are pretty amazing, and help to turn the web into a push instead of
+pull platform. We have support for hitting a URL whenever you commit to your
+project and we will try and rebuild your docs. This only rebuilds them if
+something has changed, so it is cheap on the server side.
 
-As anyone who has worked with push knows, pushing a doc update to your repo and watching it get updated within seconds is an awesome feeling. If you're on github, simply put `http://readthedocs.org/github` as a post-commit hook on your project. Otherwise your project detail page has your post-commit hook on it. It will look something along the lines of `http://readthedocs.org/build/<pk>`
+As anyone who has worked with push knows, pushing a doc update to your repo and
+watching it get updated within seconds is an awesome feeling. If you're on
+github, simply put ``http://readthedocs.org/github`` as a post-commit hook on
+your project. Otherwise your project detail page has your post-commit hook on
+it. It will look something along the lines of
+``http://readthedocs.org/build/<pk>``