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

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented May 31, 2018

Related to #4166

@@ -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)

@@ -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)

@@ -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

@ericholscher ericholscher merged commit 2bc6bd8 into readthedocs:master May 31, 2018
@stsewd stsewd deleted the remove-some-warnings branch May 31, 2018 14:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants