Merge tag '9.10.1' into relcorp

Author: ericholscher

.github/workflows/pip-tools.yaml

@@ -48,7 +48,7 @@ jobs:
         run: pip-compile --upgrade --resolver=backtracking --output-file=requirements/deploy.txt requirements/deploy.in
 
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v4
+        uses: peter-evans/create-pull-request@v5
         with:
           add-paths: |
             requirements/*.txt

CHANGELOG.rst

@@ -1,3 +1,29 @@
+Version 9.10.1
+--------------
+
+:Date: April 11, 2023
+
+* `@dependabot[bot] <https://github.com/dependabot[bot]>`__: Bump peter-evans/create-pull-request from 4 to 5 (`#10233 <https://github.com/readthedocs/readthedocs.org/pull/10233>`__)
+* `@github-actions[bot] <https://github.com/github-actions[bot]>`__: Dependencies: all packages updated via pip-tools (`#10232 <https://github.com/readthedocs/readthedocs.org/pull/10232>`__)
+* `@agjohnson <https://github.com/agjohnson>`__: Add notes on private repo support in our install docs (`#10230 <https://github.com/readthedocs/readthedocs.org/pull/10230>`__)
+* `@stsewd <https://github.com/stsewd>`__: Migrate more feature checks (`#10228 <https://github.com/readthedocs/readthedocs.org/pull/10228>`__)
+* `@stsewd <https://github.com/stsewd>`__: Analytics API: check if absolute_uri isn't present (`#10227 <https://github.com/readthedocs/readthedocs.org/pull/10227>`__)
+* `@humitos <https://github.com/humitos>`__: Docs: minor changes to examples for consistency (`#10225 <https://github.com/readthedocs/readthedocs.org/pull/10225>`__)
+* `@benjaoming <https://github.com/benjaoming>`__: Docs: Experiment with canonical url using READTHEDOCS_CANONICAL_URL (`#10224 <https://github.com/readthedocs/readthedocs.org/pull/10224>`__)
+* `@github-actions[bot] <https://github.com/github-actions[bot]>`__: Dependencies: all packages updated via pip-tools (`#10215 <https://github.com/readthedocs/readthedocs.org/pull/10215>`__)
+* `@stsewd <https://github.com/stsewd>`__: Proxito: refactor allowed_user (`#10213 <https://github.com/readthedocs/readthedocs.org/pull/10213>`__)
+* `@stsewd <https://github.com/stsewd>`__: Proxito: Test infinite redirect on non-existing PDFs (`#10212 <https://github.com/readthedocs/readthedocs.org/pull/10212>`__)
+* `@stsewd <https://github.com/stsewd>`__: API V3: support privacy levels on projects and versions (`#10210 <https://github.com/readthedocs/readthedocs.org/pull/10210>`__)
+* `@agjohnson <https://github.com/agjohnson>`__: Fix filter positional arguments (`#10202 <https://github.com/readthedocs/readthedocs.org/pull/10202>`__)
+* `@benjaoming <https://github.com/benjaoming>`__: Docs: Gather definitions in the same dl on main index page (`#10201 <https://github.com/readthedocs/readthedocs.org/pull/10201>`__)
+* `@humitos <https://github.com/humitos>`__: Release 9.10.0 (`#10200 <https://github.com/readthedocs/readthedocs.org/pull/10200>`__)
+* `@stsewd <https://github.com/stsewd>`__: Custom domains: hide https option (`#10188 <https://github.com/readthedocs/readthedocs.org/pull/10188>`__)
+* `@stsewd <https://github.com/stsewd>`__: Proxito: refactor project download view (`#10178 <https://github.com/readthedocs/readthedocs.org/pull/10178>`__)
+* `@humitos <https://github.com/humitos>`__: Build: hardcode the Docker username for now (`#10172 <https://github.com/readthedocs/readthedocs.org/pull/10172>`__)
+* `@humitos <https://github.com/humitos>`__: Build: expose VCS-related environment variables (`#10168 <https://github.com/readthedocs/readthedocs.org/pull/10168>`__)
+* `@agjohnson <https://github.com/agjohnson>`__: Automation rules: model text changes for UI (`#10138 <https://github.com/readthedocs/readthedocs.org/pull/10138>`__)
+* `@stsewd <https://github.com/stsewd>`__: Unify feature check for organization/project (`#8920 <https://github.com/readthedocs/readthedocs.org/pull/8920>`__)
+
 Version 9.10.0
 --------------
 

docs/conf.py

@@ -65,9 +65,16 @@
 
 templates_path = ["_templates"]
 
+# This may be elevated as a general issue for documentation and behavioral
+# change to the Sphinx build:
+# This will ensure that we use the correctly set environment for canonical URLs
+# Old Read the Docs injections makes it point only to the default version,
+# for instance /en/stable/
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "/")
+
 master_doc = "index"
 copyright = "Read the Docs, Inc & contributors"
-version = "9.10.0"
+version = "9.10.1"
 release = version
 exclude_patterns = ["_build", "shared", "_includes"]
 default_role = "obj"

docs/dev/install.rst

@@ -32,6 +32,27 @@ Set up your environment
 
       git clone --recurse-submodules https://github.com/readthedocs/readthedocs.org/
 
+#. Install or clone additional repositories:
+
+   .. note::
+
+      This step is only required for Read the Docs core team members.
+
+   Core team should at very least have all required packages installed in their development image.
+   To install these packages you must define a GitHub token before building your image:
+
+   .. prompt:: bash
+
+      export GITHUB_TOKEN="..."
+      export GITHUB_USER="..."
+
+   In order to make development changes on any of our private repositories,
+   such as ``ext`` or ``ext-theme``, you will also need to check these repositories out:
+
+   .. prompt:: bash
+
+      git clone --recurse-submodules https://github.com/readthedocs/ext/
+
 #. Install the requirements from ``common`` submodule:
 
    .. prompt:: bash
@@ -48,10 +69,6 @@ Set up your environment
 
       inv docker.build
 
-   .. tip::
-
-      If you pass the ``GITHUB_TOKEN`` and ``GITHUB_USER`` environment variables to this command,
-      it will add support for readthedocs-ext.
 
 #. Pull down Docker images for the builders:
 

docs/user/api/v3.rst

@@ -277,6 +277,8 @@ Project details
                 "latest": "{VERSION}",
                 "19.0.2": "{VERSION}"
             },
+            "privacy_level": "public",
+            "external_builds_privacy_level": "public",
             "_links": {
                 "_self": "/api/v3/projects/pip/",
                 "versions": "/api/v3/projects/pip/versions/",
@@ -302,7 +304,6 @@ Project details
 
          * **expand** (*string*) -- with ``organization`` and ``teams``.
 
-
 Project create
 ++++++++++++++
 
@@ -350,6 +351,8 @@ Project create
             "homepage": "http://template.readthedocs.io/",
             "programming_language": "py",
             "language": "es",
+            "privacy_level": "public",
+            "external_builds_privacy_level": "public",
             "tags": [
                 "automation",
                 "sphinx"
@@ -371,6 +374,9 @@ Project create
          * **organization** (*string*) -- required organization's slug under the project will be imported.
          * **teams** (*string*) -- optional teams' slugs the project will belong to.
 
+      .. note::
+
+         Privacy levels are only available in :doc:`Read the Docs for Business </commercial/index>`.
 
 Project update
 ++++++++++++++
@@ -429,14 +435,19 @@ Project update
             "analytics_disabled": false,
             "single_version": false,
             "external_builds_enabled": true,
-
+            "privacy_level": "public",
+            "external_builds_privacy_level": "public"
         }
 
     .. note::
 
         Adding ``tags`` will replace existing tags with the new list,
         and if omitted won't change the tags.
 
+    .. note::
+
+       Privacy levels are only available in :doc:`Read the Docs for Business </commercial/index>`.
+
     :statuscode 204: Updated successfully
 
 
@@ -534,6 +545,7 @@ Version detail
             "hidden": false,
             "type": "tag",
             "last_build": "{BUILD}",
+            "privacy_level": "public",
             "downloads": {
                 "pdf": "https://pip.readthedocs.io/_/downloads/pdf/pip/stable/",
                 "htmlzip": "https://pip.readthedocs.io/_/downloads/htmlzip/pip/stable/",
@@ -561,7 +573,6 @@ Version detail
                           Allowed values are ``last_build`` and ``last_build.config``.
                           Multiple fields can be passed separated by commas.
 
-
 Version update
 ++++++++++++++
 
@@ -602,11 +613,15 @@ Version update
 
         {
             "active": true,
-            "hidden": false
+            "hidden": false,
+            "privacy_level": "public"
         }
 
     :statuscode 204: Updated successfully
 
+    .. note::
+
+       Privacy levels are only available in :doc:`Read the Docs for Business </commercial/index>`.
 
 Builds
 ~~~~~~

docs/user/reference/environment-variables.rst

@@ -18,7 +18,11 @@ All :doc:`build processes </builds>` have the following environment variables au
     The locale name, or the identifier for the locale, for the project being built.
     This value comes from the project's configured language.
 
-    :Examples: ``en``, ``it``, ``de_AT``, ``es``, ``pt_BR``
+    :Example: ``en``
+    :Example: ``it``
+    :Example: ``de_AT``
+    :Example: ``es``
+    :Example: ``pt_BR``
 
 .. envvar:: READTHEDOCS_VERSION
 
@@ -35,7 +39,10 @@ All :doc:`build processes </builds>` have the following environment variables au
 
     The type of the version being built.
 
-    :Values: ``branch``, ``tag``, ``external`` (for :doc:`pull request builds </pull-requests>`), or ``unknown``
+    :Example: ``branch``
+    :Example: ``tag``
+    :Example: ``external`` (for :doc:`pull request builds </pull-requests>`)
+    :Example: ``unknown``
 
 .. envvar:: READTHEDOCS_VIRTUALENV_PATH
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "readthedocs",
-  "version": "9.10.0",
+  "version": "9.10.1",
   "description": "Read the Docs build dependencies",
   "author": "Read the Docs, Inc <[email protected]>",
   "scripts": {

readthedocs/__init__.py

@@ -1,4 +1,4 @@
 """Read the Docs."""
 
 
-__version__ = "9.10.0"
+__version__ = "9.10.1"

readthedocs/analytics/proxied_api.py

@@ -53,11 +53,12 @@ def get(self, request, *args, **kwargs):
         project = self._get_project()
         version = self._get_version()
         absolute_uri = self.request.GET.get('absolute_uri')
-        self.increase_page_view_count(
-            project=project,
-            version=version,
-            absolute_uri=absolute_uri,
-        )
+        if absolute_uri:
+            self.increase_page_view_count(
+                project=project,
+                version=version,
+                absolute_uri=absolute_uri,
+            )
         return Response(status=200)
 
     # pylint: disable=no-self-use

readthedocs/api/v2/views/proxied.py

@@ -1,7 +1,7 @@
 from readthedocs.api.v2.views.footer_views import BaseFooterHTML
-from readthedocs.core.utils.extend import SettingsOverrideObject
-from readthedocs.embed.views import EmbedAPIBase
 from readthedocs.core.mixins import ProxiedAPIMixin
+from readthedocs.core.utils.extend import SettingsOverrideObject
+from readthedocs.embed.views import EmbedAPI
 
 
 class BaseProxiedFooterHTML(ProxiedAPIMixin, BaseFooterHTML):
@@ -14,7 +14,7 @@ class ProxiedFooterHTML(SettingsOverrideObject):
     _default_class = BaseProxiedFooterHTML
 
 
-class ProxiedEmbedAPIBase(ProxiedAPIMixin, EmbedAPIBase):
+class ProxiedEmbedAPIBase(ProxiedAPIMixin, EmbedAPI):
 
     pass
 

readthedocs/api/v3/permissions.py

@@ -1,6 +1,32 @@
 from rest_framework.permissions import BasePermission, IsAuthenticated
 
 from readthedocs.core.utils.extend import SettingsOverrideObject
+from readthedocs.subscriptions.constants import TYPE_EMBED_API
+from readthedocs.subscriptions.models import PlanFeature
+
+
+class HasEmbedAPIAccess(BasePermission):
+
+    """
+    Check if the project being accessed has access to the Embed API.
+
+    The embedded API V3 allows getting content from external sites tha
+    aren't attached to a project. Those sites are restricted to the ones
+    from ``RTD_EMBED_API_EXTERNAL_DOMAINS``, so we just allow that.
+    """
+
+    message = (
+        "Content embedding isn't available in your current plan. "
+        "Upgrade your subscription to enable this feature. "
+        "https://about.readthedocs.com/pricing/."
+    )
+
+    def has_permission(self, request, view):
+        project = view._get_project()
+        # The project is None when the is requesting a section from an external site.
+        if project and not PlanFeature.objects.has_feature(project, TYPE_EMBED_API):
+            return False
+        return True
 
 
 class UserProjectsListing(BasePermission):

readthedocs/api/v3/serializers.py

@@ -277,6 +277,7 @@ class Meta:
             'downloads',
             'urls',
             '_links',
+            "privacy_level",
         ]
 
         expandable_fields = {
@@ -306,16 +307,25 @@ class VersionUpdateSerializer(serializers.ModelSerializer):
     """
     Used when modifying (update action) a ``Version``.
 
-    It only allows to make the Version active/non-active.
+    It allows to change the version states and privacy level only.
     """
 
     class Meta:
         model = Version
         fields = [
             'active',
             'hidden',
+            "privacy_level",
         ]
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        # If privacy levels are not allowed,
+        # everything is public, we don't allow changing it.
+        if not settings.ALLOW_PRIVATE_REPOS:
+            self.fields.pop("privacy_level")
+
 
 class LanguageSerializer(serializers.Serializer):
 
@@ -475,8 +485,18 @@ class Meta:
             "repository",
             "homepage",
             "tags",
+            "privacy_level",
+            "external_builds_privacy_level",
         )
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        # If privacy levels are not allowed,
+        # everything is public, we don't allow changing it.
+        if not settings.ALLOW_PRIVATE_REPOS:
+            self.fields.pop("privacy_level")
+            self.fields.pop("external_builds_privacy_level")
+
     def _validate_remote_repository(self, data):
         """
         Validate connection between `Project` and `RemoteRepository`.
@@ -565,11 +585,21 @@ class Meta:
             'show_version_warning',
             'single_version',
             'external_builds_enabled',
+            "privacy_level",
+            "external_builds_privacy_level",
 
             # NOTE: we do not allow to change any setting that can be set via
             # the YAML config file.
         )
 
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        # If privacy levels are not allowed,
+        # everything is public, we don't allow changing it.
+        if not settings.ALLOW_PRIVATE_REPOS:
+            self.fields.pop("privacy_level")
+            self.fields.pop("external_builds_privacy_level")
+
 
 class ProjectUpdateSerializer(SettingsOverrideObject):
     _default_class = ProjectUpdateSerializerBase
@@ -622,6 +652,8 @@ class Meta:
             'translation_of',
             'urls',
             'tags',
+            "privacy_level",
+            "external_builds_privacy_level",
 
             # NOTE: ``expandable_fields`` must not be included here. Otherwise,
             # they will be tried to be rendered and fail

readthedocs/api/v3/tests/mixins.py

@@ -80,6 +80,9 @@ def setUp(self):
             active=True,
             built=True,
             type=TAG,
+            has_pdf=True,
+            has_epub=True,
+            has_htmlzip=True,
         )
 
         self.build = fixture.get(