Merge pull request #4172 from stsewd/remove-some-warnings

Fix some warnings on docs

Author: ericholscher

docs/api/projects.rst

@@ -21,11 +21,6 @@
 .. automodule:: readthedocs.projects.models
     :members:
 
-:mod:`readthedocs.projects.search_indexes`
-------------------------------------------
-.. automodule:: readthedocs.projects.search_indexes
-    :members:
-
 :mod:`readthedocs.projects.tasks`
 ---------------------------------
 .. automodule:: readthedocs.projects.tasks

docs/privacy-policy.rst

@@ -102,7 +102,7 @@ Why do we collect this?
 - We limit our use of your User Personal Information to the purposes listed in this Privacy Statement.
   If we need to use your User Personal Information for other purposes, we will ask your permission first.
   You can always see what information we have in your
-  `user account <https://readthedocs.org/accounts/edit/>`_.
+  `user account <https://readthedocs.org/accounts/edit/>`__.
 
 What information Read the Docs does not collect
 -----------------------------------------------
@@ -367,7 +367,7 @@ How you can access and control the information we collect
 
 If you're already a Read the Docs user, you may access, update, alter,
 or delete your basic user profile information by
-`editing your user account <https://readthedocs.org/accounts/edit/>`_.
+`editing your user account <https://readthedocs.org/accounts/edit/>`__.
 
 
 Data retention and deletion
@@ -383,7 +383,7 @@ so unless you choose to delete your account,
 we will retain your account information indefinitely.
 
 If you would like to delete your User Personal Information,
-you may do so in your `user account <https://readthedocs.org/accounts/delete/>`_.
+you may do so in your `user account <https://readthedocs.org/accounts/delete/>`__.
 We will retain and use your information as necessary to comply with
 our legal obligations, resolve disputes, and enforce our agreements,
 but barring legal requirements, we will delete your full profile.

docs/team.rst

@@ -32,9 +32,9 @@ This might include tasks like:
 Members
 ~~~~~~~
 
-* `Eric Holscher <https://github.com/ericholscher>`_ (Pacific Time)
-* `Anthony Johnson <https://github.com/agjohnson>`_ (Mountain Time)
-* `Manuel Kaufmann <https://github.com/humitos>`_ (Central Time)
+* `Eric Holscher <https://github.com/ericholscher>`__ (Pacific Time)
+* `Anthony Johnson <https://github.com/agjohnson>`__ (Mountain Time)
+* `Manuel Kaufmann <https://github.com/humitos>`__ (Central Time)
 * Your Name Here
 
 Feel free to ask any of us if you have questions or want to join!

readthedocs/builds/managers.py

@@ -19,7 +19,7 @@ class VersionManagerBase(models.Manager):
     """
     Version manager for manager only queries.
 
-    For queries not suitable for the :py:cls:`VersionQuerySet`, such as create
+    For queries not suitable for the :py:class:`VersionQuerySet`, such as create
     queries.
     """
 

readthedocs/builds/models.py

@@ -356,7 +356,8 @@ class APIVersion(Version):
     Version proxy model for API data deserialization.
 
     This replaces the pattern where API data was deserialized into a mocked
-    :py:cls:`Version` object. This pattern was confusing, as it was not explicit
+    :py:class:`Version` object.
+    This pattern was confusing, as it was not explicit
     as to what form of object you were working with -- API backed or database
     backed.
 

readthedocs/core/utils/extend.py

@@ -15,7 +15,7 @@ def get_override_class(proxy_class, default_class=None):
     The `proxy_class` is the main class that is used, and `default_class` is the
     default class that this proxy class will instantiate.  If `default_class` is
     not defined, this will be inferred from the `proxy_class`, as is defined in
-    :py:cls:`SettingsOverrideObject`.
+    :py:class:`SettingsOverrideObject`.
     """
     if default_class is None:
         default_class = getattr(proxy_class, '_default_class')

readthedocs/core/views/hooks.py

@@ -163,7 +163,7 @@ def github_build(request):  # noqa: D205
     GitHub webhook consumer.
 
     .. warning:: **DEPRECATED**
-        Use :py:cls:`readthedocs.restapi.views.integrations.GitHubWebhookView`
+        Use :py:class:`readthedocs.restapi.views.integrations.GitHubWebhookView`
         instead of this view function
 
     This will search for projects matching either a stripped down HTTP or SSH
@@ -218,7 +218,7 @@ def gitlab_build(request):  # noqa: D205
     GitLab webhook consumer.
 
     .. warning:: **DEPRECATED**
-        Use :py:cls:`readthedocs.restapi.views.integrations.GitLabWebhookView`
+        Use :py:class:`readthedocs.restapi.views.integrations.GitLabWebhookView`
         instead of this view function
 
     Search project repository URLs using the site URL from GitLab webhook payload.
@@ -253,7 +253,7 @@ def bitbucket_build(request):
     Consume webhooks from multiple versions of Bitbucket's API.
 
     .. warning:: **DEPRECATED**
-        Use :py:cls:`readthedocs.restapi.views.integrations.BitbucketWebhookView`
+        Use :py:class:`readthedocs.restapi.views.integrations.BitbucketWebhookView`
         instead of this view function
 
     New webhooks are set up with v2, but v1 webhooks will still point to this
@@ -327,7 +327,7 @@ def generic_build(request, project_id_or_slug=None):
 
     .. warning:: **DEPRECATED**
 
-      Use :py:cls:`readthedocs.restapi.views.integrations.GenericWebhookView`
+      Use :py:class:`readthedocs.restapi.views.integrations.GenericWebhookView`
       instead of this view function
     """
     try:

readthedocs/doc_builder/environments.py

@@ -389,7 +389,7 @@ class BuildEnvironment(BaseEnvironment):
     Any exceptions raised inside this context and handled by the eventual
     :py:meth:`__exit__` method, specifically, inside :py:meth:`handle_exception`
     and :py:meth:`update_build`. If the exception is a subclass of
-    :py:cls:`BuildEnvironmentError`, then this error message is added to the
+    :py:class:`BuildEnvironmentError`, then this error message is added to the
     build object and is shown to the user as the top-level failure reason for
     why the build failed. Other exceptions raise a general failure warning on
     the build.

readthedocs/projects/models.py

@@ -850,7 +850,7 @@ class APIProject(Project):
     Project proxy model for API data deserialization.
 
     This replaces the pattern where API data was deserialized into a mocked
-    :py:cls:`Project` object. This pattern was confusing, as it was not explicit
+    :py:class:`Project` object. This pattern was confusing, as it was not explicit
     as to what form of object you were working with -- API backed or database
     backed.
 

readthedocs/projects/views/mixins.py

@@ -13,7 +13,7 @@ class ProjectRelationMixin(object):
     Mixin class for constructing model views for project dashboard.
 
     This mixin class is used for model views on models that have a relation
-    to the :py:cls:`Project` model.
+    to the :py:class:`Project` model.
 
     :cvar project_lookup_url_kwarg: URL kwarg to use in project lookup
     :cvar project_lookup_field: Query field for project relation

readthedocs/rtd_tests/tests/test_project_symlinks.py

@@ -59,7 +59,7 @@ class TempSiterootCase(object):
     temporary path.  Each test is therefore isolated, and cleanup will remove
     these paths after the test case wraps up.
 
-    And subclasses that implement :py:cls:`TestCase` should also make use of
+    And subclasses that implement :py:class:`TestCase` should also make use of
     :py:func:`override_settings`.
     """