diff --git a/docs/api/core.rst b/docs/api/core.rst index 393b748ac5d..b0b99966212 100644 --- a/docs/api/core.rst +++ b/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: diff --git a/docs/gsoc.rst b/docs/gsoc.rst deleted file mode 100644 index 07ce66a0d55..00000000000 --- a/docs/gsoc.rst +++ /dev/null @@ -1,65 +0,0 @@ -Google Summer of Code -===================== - -Read the Docs is hoping to participate in the Google Summer of Code in 2014. -This page will contain all the information for students and anyone else interested in helping. - -.. note:: We are currently not planning on working on GSOC this year. - -Required Skills ---------------- - -Incoming students will need the following skills: - -* Intermediate python programming -* Familiarity with Markdown, reStructuredText, or some other plain text markup language -* Familiarity with git, or some other source control -* Ability to set up your own development environment for Read the Docs -* An interest in documentation and improving open source documentation tools would be great too! - -We're happy to help you get up to speed, but the more you are able to demonstrate ability in advance, the more likely we are to choose your application! - -Getting Started ---------------- - -The :doc:`install` doc is probably the best place to get going. -It will walk you through getting a basic environment for Read the Docs setup. - -Then you can look through our :doc:`contribute` doc for information on how to get started contributing to RTD. -If you try and submit a patch, -or at least comment on a bug before applying, -you will be much more likely to be accepted. - - -Want to get involved? ---------------------- - -If you're interested in participating in GSoC 2014 as a student, mentor, or interested community member, you should join the `mailing list`_ and post any questions, comments, etc. you may have - -In addition you may be able to find us on IRC at ``#readthedocs`` on ``irc.freenode.org``. If no one is available to answer your question, please be patient and post it to the mailing list as well. - -.. _mailing list: https://groups.google.com/forum/#!forum/readthedocs - -Project Ideas -------------- - -We have some medium sized projects sketched out in our issue tracker with the tag *Feature Overview*. -Looking through `these issues`_ is a good place to start. - -.. _these issues: https://github.com/rtfd/readthedocs.org/issues?direction=desc&labels=Feature+Overview&page=1&sort=updated&state=open - -Possible Mentors ----------------- - -* Eric Holscher -* Wraithan McDonald -* Justin Abrahams -* Jannis Leidel - -Thanks ------- - -This page was heavily inspired by Mailman's similar `GSOC page`_. -Thanks for the inspiration. - -.. _GSOC page: http://wiki.list.org/display/DEV/Google+Summer+of+Code+2014 diff --git a/docs/i18n.rst b/docs/i18n.rst index 77854e5724c..174d560fb33 100644 --- a/docs/i18n.rst +++ b/docs/i18n.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 `` (for non-English). diff --git a/docs/index.rst b/docs/index.rst index e79808fafb8..ae0efb69b55 100644 --- a/docs/index.rst +++ b/docs/index.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 diff --git a/docs/user-defined-redirects.rst b/docs/user-defined-redirects.rst index d64a595b43b..6987c9de6ba 100644 --- a/docs/user-defined-redirects.rst +++ b/docs/user-defined-redirects.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* diff --git a/readthedocs/builds/models.py b/readthedocs/builds/models.py index 5e37b226dd9..32cf481ca13 100644 --- a/readthedocs/builds/models.py +++ b/readthedocs/builds/models.py @@ -32,29 +32,6 @@ 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( @@ -62,10 +39,23 @@ class Version(models.Model): 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') diff --git a/readthedocs/core/management/commands/import_intersphinx.py b/readthedocs/core/management/commands/import_intersphinx.py deleted file mode 100644 index f89b79ae003..00000000000 --- a/readthedocs/core/management/commands/import_intersphinx.py +++ /dev/null @@ -1,11 +0,0 @@ -from django.core.management.base import BaseCommand - -from readthedocs.builds.constants import LATEST -from readthedocs.builds.models import Version -from readthedocs.projects.tasks import update_intersphinx - - -class Command(BaseCommand): - def handle(self, *args, **options): - for version in Version.objects.filter(slug=LATEST): - update_intersphinx(version.pk) diff --git a/readthedocs/core/management/commands/sync_builds.py b/readthedocs/core/management/commands/sync_builds.py deleted file mode 100644 index b0928551c09..00000000000 --- a/readthedocs/core/management/commands/sync_builds.py +++ /dev/null @@ -1,55 +0,0 @@ -import logging - -from django.core.management.base import BaseCommand -from optparse import make_option -from readthedocs.builds.models import Version -from readthedocs.core.utils import copy_to_app_servers - -log = logging.getLogger(__name__) - - -class Command(BaseCommand): - - """ - Custom management command to rebuild documentation for all projects. - - Invoked via ``./manage.py update_repos``. - """ - - option_list = BaseCommand.option_list + ( - make_option('-V', - dest='version', - default=None, - help='Build a version, or all versions'), - make_option('-c', - action='store_true', - dest='checkout', - default=False, - help='sync checkouts'), - ) - - def handle(self, *args, **options): - version = options['version'] - if len(args): - for slug in args: - log.info("Updating all versions for %s" % slug) - for version in Version.objects.filter(project__slug=slug, - active=True): - path = version.project.rtd_build_path(version.slug) - copy_to_app_servers(path, path) - else: - log.info("Updating all versions") - for version in Version.objects.filter(active=True): - try: - log.info("Syncing %s" % version) - if options['checkout']: - path = version.project.checkout_path(version.slug) - else: - path = version.project.rtd_build_path(version.slug) - copy_to_app_servers(path, path) - except Exception: - log.error("Failed to update %s" % version, exc_info=True) - - @property - def help(self): - return Command.__doc__ diff --git a/readthedocs/core/search_sites.py b/readthedocs/core/search_sites.py deleted file mode 100644 index a3653e8fd91..00000000000 --- a/readthedocs/core/search_sites.py +++ /dev/null @@ -1,4 +0,0 @@ -import haystack - - -haystack.autodiscover()