Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix some warnings on docs #4172

Merged
merged 4 commits into from
May 31, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions docs/api/projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,6 @@
.. automodule:: readthedocs.projects.models
:members:

:mod:`readthedocs.projects.search_indexes`
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was removed in a cleanup (#4039)

------------------------------------------
.. automodule:: readthedocs.projects.search_indexes
:members:

:mod:`readthedocs.projects.tasks`
---------------------------------
.. automodule:: readthedocs.projects.tasks
Expand Down
6 changes: 3 additions & 3 deletions docs/privacy-policy.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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/>`__.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using anonymous refs is recommended (lost the link for this statement :/, but it was on a sphinx issue)


What information Read the Docs does not collect
-----------------------------------------------
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/team.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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!
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/builds/managers.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Somewhere in the time this was renamed to :py:class: http://www.sphinx-doc.org/en/stable/domains.html#role-py:class

queries.
"""

Expand Down
3 changes: 2 additions & 1 deletion readthedocs/builds/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion readthedocs/core/utils/extend.py
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down
8 changes: 4 additions & 4 deletions readthedocs/core/views/hooks.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/doc_builder/environments.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/projects/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion readthedocs/projects/views/mixins.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion readthedocs/rtd_tests/tests/test_project_symlinks.py
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
"""

Expand Down