Merge pull request #2578 from lukegb/docs-cleanup

Clean up documentation

Author: ericholscher

docs/api/core.rst

@@ -21,11 +21,6 @@
 .. automodule:: readthedocs.core.models
     :members:
 
-:mod:`readthedocs.core.search_sites`
-------------------------------------
-.. automodule:: readthedocs.core.search_sites
-    :members:
-
 :mod:`readthedocs.core.views`
 -----------------------------
 .. automodule:: readthedocs.core.views
@@ -36,9 +31,35 @@
 -------------------------------------------
 This is where custom ``manage.py`` commands are defined.
 
-.. automodule:: readthedocs.core.management.commands.build_files
+.. automodule:: readthedocs.core.management.commands.archive
+    :members:
+
+.. automodule:: readthedocs.core.management.commands.clean_builds
+    :members:
+
+.. automodule:: readthedocs.core.management.commands.import_github_language
+    :members:
+
+.. automodule:: readthedocs.core.management.commands.import_github
+    :members:
+
+.. automodule:: readthedocs.core.management.commands.pull
+    :members:
+
+.. automodule:: readthedocs.core.management.commands.reindex_elasticsearch
+    :members:
+
+.. automodule:: readthedocs.core.management.commands.set_metadata
+    :members:
+
+.. automodule:: readthedocs.core.management.commands.symlink
+    :members:
+
+.. automodule:: readthedocs.core.management.commands.update_api
     :members:
 
 .. automodule:: readthedocs.core.management.commands.update_repos
     :members:
 
+.. automodule:: readthedocs.core.management.commands.update_versions
+    :members:

docs/gsoc.rst

@@ -247,7 +247,7 @@ Administrative Tasks
 
 
 Updating Localization Files
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 To update the translation source files (eg if you changed or added translatable
 strings in the templates or Python code) you should run ``python manage.py
@@ -262,7 +262,7 @@ crowd-sourced online translation tool.
 .. _i18n-compiling:
 
 Compiling to MO
-~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^
 
 Gettext doesn't parse any text files, it reads a binary format for faster
 performance. To compile the latest PO files in the repository, Django provides
@@ -281,7 +281,7 @@ make sure you don't forcibly add them to the repository.
 
 
 Transifex Integration
-~~~~~~~~~~~~~~~~~~~~~
+^^^^^^^^^^^^^^^^^^^^^
 
 To push updated translation source files to Transifex, run ``tx
 push -s`` (for English) or ``tx push -t <language>`` (for non-English).

docs/i18n.rst

@@ -7,7 +7,7 @@ We pull your code from your Subversion_, Bazaar_, Git_, and Mercurial_ repositor
 Then we build documentation and host it for you.
 Think of it as *Continuous Documentation*.
 
-The code is open source, and `available on github`_.
+The code is open source, and `available on GitHub`_.
 
 .. _Read the docs: http://readthedocs.org/
 .. _Sphinx: http://sphinx.pocoo.org/
@@ -18,7 +18,7 @@ The code is open source, and `available on github`_.
 .. _Bazaar: http://bazaar.canonical.com/
 .. _Git: http://git-scm.com/
 .. _Mercurial: http://mercurial.selenic.com/
-.. _available on github: http://github.com/rtfd/readthedocs.org
+.. _available on GitHub: http://github.com/rtfd/readthedocs.org
 
 The main documentation for the site is organized into a couple sections:
 
@@ -30,7 +30,6 @@ Information about development is also available:
 
 * :ref:`dev-docs`
 * :ref:`design-docs`
-* :ref:`ops-docs`
 
 .. _user-docs:
 
@@ -46,6 +45,8 @@ Information about development is also available:
    faq
    yaml-config
    guides/index
+   api
+   embed
 
 .. _about-docs:
 
@@ -58,6 +59,8 @@ Information about development is also available:
    ethical-advertising
    sponsors
    open-source-philosophy
+   story
+   talks
 
 .. _feature-docs:
 
@@ -87,6 +90,7 @@ Information about development is also available:
    :caption: Developer Documentation
 
    install
+   api/index
    changelog
    tests
    docs

docs/index.rst

@@ -48,7 +48,7 @@ Note that the ``/`` at the start doesn't count the ``/en/latest``,
 but just the user-controlled section of the URL.
 
 Exact Redirects
---------------
+---------------
 
 If you're redirecting from an old host AND you aren't maintaining old paths for your
 documents, a Prefix Redirect won't suffice and you'll need to create *Exact Redirects*

docs/user-defined-redirects.rst

@@ -32,40 +32,30 @@
 
 
 class Version(models.Model):
-
-    """
-    Attributes
-    ----------
-
-    ``identifier``
-        The identifier is the ID for the revision this is version is for. This
-        might be the revision number (e.g. in SVN), or the commit hash (e.g. in
-        Git). If the this version is pointing to a branch, then ``identifier``
-        will contain the branch name.
-
-    ``verbose_name``
-        This is the actual name that we got for the commit stored in
-        ``identifier``. This might be the tag or branch name like ``"v1.0.4"``.
-        However this might also hold special version names like ``"latest"``
-        and ``"stable"``.
-
-    ``slug``
-        The slug is the slugified version of ``verbose_name`` that can be used
-        in the URL to identify this version in a project. It's also used in the
-        filesystem to determine how the paths for this version are called. It
-        must not be used for any other identifying purposes.
-    """
     project = models.ForeignKey(Project, verbose_name=_('Project'),
                                 related_name='versions')
     type = models.CharField(
         _('Type'), max_length=20,
         choices=VERSION_TYPES, default='unknown',
     )
     # used by the vcs backend
+
+    #: The identifier is the ID for the revision this is version is for. This
+    #: might be the revision number (e.g. in SVN), or the commit hash (e.g. in
+    #: Git). If the this version is pointing to a branch, then ``identifier``
+    #: will contain the branch name.
     identifier = models.CharField(_('Identifier'), max_length=255)
 
+    #: This is the actual name that we got for the commit stored in
+    #: ``identifier``. This might be the tag or branch name like ``"v1.0.4"``.
+    #: However this might also hold special version names like ``"latest"``
+    #: and ``"stable"``.
     verbose_name = models.CharField(_('Verbose Name'), max_length=255)
 
+    #: The slug is the slugified version of ``verbose_name`` that can be used
+    #: in the URL to identify this version in a project. It's also used in the
+    #: filesystem to determine how the paths for this version are called. It
+    #: must not be used for any other identifying purposes.
     slug = VersionSlugField(_('Slug'), max_length=255,
                             populate_from='verbose_name')