Merge branch 'master' into remove-highlight-url-params

Author: ericholscher

CHANGELOG.rst

@@ -1,3 +1,23 @@
+Version 3.7.4
+-------------
+
+:Date: September 05, 2019
+
+* `@ericholscher <http://github.com/ericholscher>`__: Remove paid support callout (`#6140 <https://github.com/readthedocs/readthedocs.org/pull/6140>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Fix IntegrationAdmin with raw_id_fields for Projects (`#6136 <https://github.com/readthedocs/readthedocs.org/pull/6136>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Fix link to html_extra_path (`#6135 <https://github.com/readthedocs/readthedocs.org/pull/6135>`__)
+* `@stsewd <http://github.com/stsewd>`__: Move out authorization from FooterHTML view (`#6133 <https://github.com/readthedocs/readthedocs.org/pull/6133>`__)
+* `@agjohnson <http://github.com/agjohnson>`__: Add setting for always cleaning the build post-build (`#6132 <https://github.com/readthedocs/readthedocs.org/pull/6132>`__)
+* `@pyup-bot <http://github.com/pyup-bot>`__: pyup:  Scheduled weekly dependency update for week 35 (`#6129 <https://github.com/readthedocs/readthedocs.org/pull/6129>`__)
+* `@stsewd <http://github.com/stsewd>`__:  Refactor footer_html view to class (`#6125 <https://github.com/readthedocs/readthedocs.org/pull/6125>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Use raw_id_fields in the TokenAdmin (`#6116 <https://github.com/readthedocs/readthedocs.org/pull/6116>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Fixed footer ads supported on all themes (`#6115 <https://github.com/readthedocs/readthedocs.org/pull/6115>`__)
+* `@stsewd <http://github.com/stsewd>`__: Don't log BuildEnvironmentWarning as error (`#6112 <https://github.com/readthedocs/readthedocs.org/pull/6112>`__)
+* `@pllim <http://github.com/pllim>`__: Use the force when fetching with Git (`#6109 <https://github.com/readthedocs/readthedocs.org/pull/6109>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Record search queries smartly (`#6088 <https://github.com/readthedocs/readthedocs.org/pull/6088>`__)
+* `@stsewd <http://github.com/stsewd>`__: Add move method to automation rule (`#5998 <https://github.com/readthedocs/readthedocs.org/pull/5998>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Index more domain data into elasticsearch (`#5979 <https://github.com/readthedocs/readthedocs.org/pull/5979>`__)
+
 Version 3.7.3
 -------------
 

docs/custom_installs/index.rst

@@ -12,9 +12,8 @@ It has those features and more!
 
 .. warning::
     These documents are maintained by the community, and might not be up to date.
-    Read the Docs developers do not support custom installs of our software
-    in our public issue tracker. For additional support of a custom installation,
-    please see our `paid support plans <https://readthedocs.com/services/#open-source-support>`_.
+    Read the Docs developers do not support custom installs of our software,
+    as mentioned in our :doc:`/open-source-philosophy`.
 
 .. toctree::
     :maxdepth: 2

docs/faq.rst

@@ -257,7 +257,7 @@ To accomplish this, you can add a ``robots.txt`` file to your documentation's ro
 
 
 Minimal example of ``robots.txt``
-+++++++++++++++++++++++++++++++++
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 ::
 
@@ -270,22 +270,28 @@ Minimal example of ``robots.txt``
    See `Google's docs`_ for its full syntax.
 
 This file has to be served as is under ``/robots.txt``.
-Depending if you are using Sphinx or MkDocs, you will need a different configuration for this.
 
+Setup
+~~~~~
 
-Sphinx
-~~~~~~
+The ``robots.txt`` file will be served from the **default version** of your Project.
+This is because the ``robots.txt`` file is served at the top-level of your domain,
+so we must choose a version to find the file in.
+The **default version** is the best place to look for it.
+
+Sphinx and Mkdocs both have different ways of outputting static files in the build:
 
-Sphinx uses `html_extra`_ option to add static files to the output.
-You need to create a ``robots.txt`` file and put it under the path defined in ``html_extra``.
+Sphinx
+++++++
 
+Sphinx uses `html_extra_path`_ option to add static files to the output.
+You need to create a ``robots.txt`` file and put it under the path defined in ``html_extra_path``.
 
 MkDocs
-~~~~~~
+++++++
 
 MkDocs needs the ``robots.txt`` to be at the directory defined at `docs_dir`_ config.
 
-
 .. _Google's docs: https://support.google.com/webmasters/answer/6062608
-.. _html_extra: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_extra_path
+.. _html_extra_path: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_extra_path
 .. _docs_dir: https://www.mkdocs.org/user-guide/configuration/#docs_dir

docs/gsoc.rst

@@ -94,25 +94,6 @@ This could include:
 * Taking a swagger YAML file and generating HTML properly with Sphinx
 * Integration with our existing API to generate Swagger output
 
-Autobuild docs for Pull Requests
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-It would be great to automatically build docs for Pull Requests in GitHub repos that our users have.
-Currently we don't support this,
-and it's one of our most requested features.
-
-This would include:
-
-* Modeling Pull Requests as a type of version alongside Tags and Branches
-* Modifying how we upload HTML docs to store them in a place like S3 for long term storage
-* Build integration with GitHub to send the status notifications when a PR is building and complete
-
-More info here: 
-
-* https://github.com/readthedocs/readthedocs.org/issues/1340
-* https://github.com/readthedocs/readthedocs.org/issues/2465
-
-
 Build a new Sphinx theme
 ~~~~~~~~~~~~~~~~~~~~~~~~
 

readthedocs/api/v2/permissions.py

@@ -2,6 +2,7 @@
 
 from rest_framework import permissions
 
+from readthedocs.builds.models import Version
 from readthedocs.core.permissions import AdminPermission
 
 
@@ -83,3 +84,32 @@ def has_object_permission(self, request, view, obj):
             request.method in permissions.SAFE_METHODS or
             (request.user and request.user.is_staff)
         )
+
+
+class IsAuthorizedToViewVersion(permissions.BasePermission):
+
+    """
+    Checks if the user from the request has permissions to see the version.
+
+    This permission class used in the FooterHTML view.
+
+    .. note::
+
+       Views using this permissions should implement the
+       `_get_version` and `_get_project` methods.
+    """
+
+    def has_permission(self, request, view):
+        project = view._get_project()
+        version = view._get_version()
+        has_access = (
+            Version.objects
+            .public(
+                user=request.user,
+                project=project,
+                only_active=False,
+            )
+            .filter(pk=version.pk)
+            .exists()
+        )
+        return has_access

readthedocs/api/v2/urls.py

@@ -56,7 +56,7 @@
 
 function_urls = [
     url(r'docurl/', core_views.docurl, name='docurl'),
-    url(r'footer_html/', footer_views.footer_html, name='footer_html'),
+    url(r'footer_html/', footer_views.FooterHTML.as_view(), name='footer_html'),
 ]
 
 task_urls = [