Merge pull request #1510 from rtfd/fix-autodoc-paths

Change docs import path and prefix APIs with readthedocs namespace

Author: ericholscher

docs/api/bookmarks.rst

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

docs/api/builds.rst

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

docs/api/core.rst

@@ -1,44 +1,44 @@
-:mod:`core`
-===========
+:mod:`readthedocs.core`
+=======================
 
-:mod:`core.admin`
-----------------------------------
-.. automodule:: core.admin
+:mod:`readthedocs.core.admin`
+-----------------------------
+.. automodule:: readthedocs.core.admin
     :members:
 
-:mod:`core.forms`
-----------------------------------
-.. automodule:: core.forms
+:mod:`readthedocs.core.forms`
+-----------------------------
+.. automodule:: readthedocs.core.forms
     :members:
 
-:mod:`core.middleware`
+:mod:`readthedocs.core.middleware`
 ----------------------------------
-.. automodule:: core.middleware
+.. automodule:: readthedocs.core.middleware
     :members:
 
-:mod:`core.models`
-----------------------------------
-.. automodule:: core.models
+:mod:`readthedocs.core.models`
+------------------------------
+.. automodule:: readthedocs.core.models
     :members:
 
-:mod:`core.search_sites`
-----------------------------------
-.. automodule:: core.search_sites
+:mod:`readthedocs.core.search_sites`
+------------------------------------
+.. automodule:: readthedocs.core.search_sites
     :members:
 
-:mod:`core.views`
-----------------------------------
-.. automodule:: core.views
+:mod:`readthedocs.core.views`
+-----------------------------
+.. automodule:: readthedocs.core.views
     :members:
 
 
-:mod:`core.management.commands`
-----------------------------------
+:mod:`readthedocs.core.management.commands`
+-------------------------------------------
 This is where custom ``manage.py`` commands are defined.
 
-.. automodule:: core.management.commands.build_files
+.. automodule:: readthedocs.core.management.commands.build_files
     :members:
 
-.. automodule:: core.management.commands.update_repos
+.. automodule:: readthedocs.core.management.commands.update_repos
     :members:
 

docs/api/doc_builder.rst

@@ -1,21 +1,21 @@
-:mod:`doc_builder`
-==================
+:mod:`readthedocs.doc_builder`
+==============================
 
-:mod:`doc_builder.base`
-----------------------------------
-.. automodule:: doc_builder.base
+:mod:`readthedocs.doc_builder.base`
+-----------------------------------
+.. automodule:: readthedocs.doc_builder.base
     :members:
 
-:mod:`doc_builder.envrionments`
--------------------------------
-.. automodule:: doc_builder.environments
+:mod:`readthedocs.doc_builder.envrionments`
+-------------------------------------------
+.. automodule:: readthedocs.doc_builder.environments
     :members:
 
-:mod:`doc_builder.backends`
-----------------------------------
+:mod:`readthedocs.doc_builder.backends`
+---------------------------------------
 
 
-:mod:`doc_builder.backends.sphinx`
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. automodule:: doc_builder.backends.sphinx
+:mod:`readthedocs.doc_builder.backends.sphinx`
+----------------------------------------------
+.. automodule:: readthedocs.doc_builder.backends.sphinx
     :members:

docs/api/projects.rst

@@ -1,51 +1,51 @@
-:mod:`projects`
-===============
+:mod:`readthedocs.projects`
+===========================
 
-:mod:`projects.admin`
-----------------------------------
-.. automodule:: projects.admin
+:mod:`readthedocs.projects.admin`
+---------------------------------
+.. automodule:: readthedocs.projects.admin
     :members:
 
-:mod:`projects.constants`
-----------------------------------
-.. automodule:: projects.constants
+:mod:`readthedocs.projects.constants`
+-------------------------------------
+.. automodule:: readthedocs.projects.constants
     :members:
 
-:mod:`projects.forms`
-----------------------------------
-.. automodule:: projects.forms
+:mod:`readthedocs.projects.forms`
+---------------------------------
+.. automodule:: readthedocs.projects.forms
     :members:
 
-:mod:`projects.models`
+:mod:`readthedocs.projects.models`
 ----------------------------------
-.. automodule:: projects.models
+.. automodule:: readthedocs.projects.models
     :members:
 
-:mod:`projects.search_indexes`
-----------------------------------
-.. automodule:: projects.search_indexes
+:mod:`readthedocs.projects.search_indexes`
+------------------------------------------
+.. automodule:: readthedocs.projects.search_indexes
     :members:
 
-:mod:`projects.tasks`
-----------------------------------
-.. automodule:: projects.tasks
+:mod:`readthedocs.projects.tasks`
+---------------------------------
+.. automodule:: readthedocs.projects.tasks
     :members:
 
-:mod:`projects.utils`
-----------------------------------
-.. automodule:: projects.utils
+:mod:`readthedocs.projects.utils`
+---------------------------------
+.. automodule:: readthedocs.projects.utils
     :members:
 
-:mod:`projects.views`
-----------------------------------
+:mod:`readthedocs.projects.views`
+---------------------------------
 
-:mod:`projects.views.public`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. automodule:: projects.views.public
+:mod:`readthedocs.projects.views.public`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. automodule:: readthedocs.projects.views.public
     :members:
 
-:mod:`projects.views.private`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-.. automodule:: projects.views.private
+:mod:`readthedocs.projects.views.private`
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+.. automodule:: readthedocs.projects.views.private
     :members:
 

docs/api/vcs_support.rst

@@ -1,9 +1,9 @@
-:mod:`vcs_support`
-==================
+:mod:`readthedocs.vcs_support`
+==============================
 
-:mod:`vcs_support.base`
------------------------
+:mod:`readthedocs.vcs_support.base`
+-----------------------------------
 
-.. automodule:: vcs_support.base
+.. automodule:: readthedocs.vcs_support.base
     :members:
 

docs/conf.py

@@ -5,8 +5,9 @@
 
 from recommonmark.parser import CommonMarkParser
 
-sys.path.insert(0, os.path.abspath('../readthedocs'))
-os.environ.setdefault("DJANGO_SETTINGS_MODULE", "settings.sqlite")
+sys.path.insert(0, os.path.abspath('..'))
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "readthedocs.settings.sqlite")
+
 from django.conf import settings
 
 import django