merge commit

Author: tapaswenipathak

CHANGELOG.rst

@@ -1,3 +1,56 @@
+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
+-------------
+
+:Date: August 27, 2019
+
+* `@pllim <http://github.com/pllim>`__: Use the force when fetching with Git (`#6109 <https://github.com/readthedocs/readthedocs.org/pull/6109>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Small improvements to the SEO guide (`#6105 <https://github.com/readthedocs/readthedocs.org/pull/6105>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Update intersphinx mapping with canonical sources (`#6085 <https://github.com/readthedocs/readthedocs.org/pull/6085>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Fix lingering 500 issues (`#6079 <https://github.com/readthedocs/readthedocs.org/pull/6079>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Technical docs SEO guide (`#6077 <https://github.com/readthedocs/readthedocs.org/pull/6077>`__)
+* `@saadmk11 <http://github.com/saadmk11>`__: GitLab Build Status Reporting for PR Builder (`#6076 <https://github.com/readthedocs/readthedocs.org/pull/6076>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Update ad details docs (`#6074 <https://github.com/readthedocs/readthedocs.org/pull/6074>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Gold makes projects ad-free again (`#6073 <https://github.com/readthedocs/readthedocs.org/pull/6073>`__)
+* `@saadmk11 <http://github.com/saadmk11>`__: Auto Sync and Re-Sync for Manually Created Integrations (`#6071 <https://github.com/readthedocs/readthedocs.org/pull/6071>`__)
+* `@pyup-bot <http://github.com/pyup-bot>`__: pyup:  Scheduled weekly dependency update for week 32 (`#6067 <https://github.com/readthedocs/readthedocs.org/pull/6067>`__)
+* `@saadmk11 <http://github.com/saadmk11>`__: PR Builder GitLab Integration (`#6066 <https://github.com/readthedocs/readthedocs.org/pull/6066>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Send media downloads to analytics (`#6063 <https://github.com/readthedocs/readthedocs.org/pull/6063>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: IPv6 in X-Forwarded-For fix (`#6062 <https://github.com/readthedocs/readthedocs.org/pull/6062>`__)
+* `@humitos <http://github.com/humitos>`__: Remove warning about beta state of conda support (`#6056 <https://github.com/readthedocs/readthedocs.org/pull/6056>`__)
+* `@saadmk11 <http://github.com/saadmk11>`__: Update GitLab Webhook creating to enable merge request events (`#6055 <https://github.com/readthedocs/readthedocs.org/pull/6055>`__)
+* `@ericholscher <http://github.com/ericholscher>`__: Release 3.7.2 (`#6054 <https://github.com/readthedocs/readthedocs.org/pull/6054>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Update feature flags docs (`#6053 <https://github.com/readthedocs/readthedocs.org/pull/6053>`__)
+* `@saadmk11 <http://github.com/saadmk11>`__: Add indelx.html filename to the external doc url (`#6051 <https://github.com/readthedocs/readthedocs.org/pull/6051>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Search analytics improvements (`#6050 <https://github.com/readthedocs/readthedocs.org/pull/6050>`__)
+* `@stsewd <http://github.com/stsewd>`__: Sort versions taking into consideration the vcs type (`#6049 <https://github.com/readthedocs/readthedocs.org/pull/6049>`__)
+* `@humitos <http://github.com/humitos>`__: Avoid returning invalid domain when using USE_SUBDOMAIN=True in dev (`#6026 <https://github.com/readthedocs/readthedocs.org/pull/6026>`__)
+* `@dojutsu-user <http://github.com/dojutsu-user>`__: Search analytics (`#6019 <https://github.com/readthedocs/readthedocs.org/pull/6019>`__)
+* `@tapaswenipathak <http://github.com/tapaswenipathak>`__: Remove django-guardian model (`#6005 <https://github.com/readthedocs/readthedocs.org/pull/6005>`__)
+* `@stsewd <http://github.com/stsewd>`__: Add manager and description field to AutomationRule model (`#5995 <https://github.com/readthedocs/readthedocs.org/pull/5995>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Cleanup project tags (`#5983 <https://github.com/readthedocs/readthedocs.org/pull/5983>`__)
+* `@davidfischer <http://github.com/davidfischer>`__: Search indexing with storage (`#5854 <https://github.com/readthedocs/readthedocs.org/pull/5854>`__)
+* `@wilvk <http://github.com/wilvk>`__: fix sphinx startup guide to not to fail on rtd build as per #2569 (`#5753 <https://github.com/readthedocs/readthedocs.org/pull/5753>`__)
+
 Version 3.7.2
 -------------
 

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

media/css/core.css

@@ -379,12 +379,11 @@ a.cta-btn:hover, a.cta-btn:active {
 
 /* search */
 
-.search {
-    border-bottom: solid 1px #bfbfbf;
-    margin-bottom: 24px;
-}
+.search { border-bottom: solid 1px #bfbfbf; margin-bottom: 24px; }
 .search input[type=text] { float: left; margin-right: 10px; padding: 8px 10px; }
 .search input[type=submit] { margin-top: 0; }
+/* this is same as the css class ".highlighted" */
+.search-result-item span { background-color: #ee9; padding: 0 1px; margin: 0 1px; border-radius: 3px; -moz-border-radius: 3px; -webkit-border-radius: 3px; }
 
 .filter { margin-bottom: 1em; }
 .filter dd { display: inline-block; margin-right: 0.75em; }

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 = [