Merge branch 'master' into davidfischer/ad-display-when-scrolled

Author: davidfischer

.circleci/config.yml

@@ -0,0 +1,45 @@
+version: 2.1
+
+jobs:
+  tests:
+    docker:
+      - image: 'cimg/python:3.6'
+        environment:
+          TOX_POSARGS: ''
+      - image: 'docker.elastic.co/elasticsearch/elasticsearch:6.8.12'
+        name: search
+    steps:
+      - checkout
+      - run: git submodule sync
+      - run: git submodule update --init
+      - run: pip install --user tox
+      - run: tox -e py36,codecov
+
+  checks:
+    docker:
+      - image: 'cimg/python:3.6'
+        environment:
+          NODE_VERSION: 10.17.0
+    steps:
+      - checkout
+      - run: git submodule sync
+      - run: git submodule update --init
+      - run: pip install --user tox
+      - run: scripts/circle/install_node.sh
+      - run:
+          name: Add node to the path
+          command: |
+            echo 'export PATH=~/.nvm/versions/node/v${NODE_VERSION}/bin:$PATH' >> $BASH_ENV
+            source $BASH_ENV
+      - run: tox -e migrations
+      - run: tox -e lint
+      - run: tox -e docs-lint
+      - run: tox -e docs
+      - run: tox -e eslint
+
+workflows:
+  version: 2
+  test:
+    jobs:
+      - checks
+      - tests

.travis.yml

@@ -1,3 +1,28 @@
+Version 5.6.1
+-------------
+
+:Date: October 26, 2020
+
+* `@agjohnson <https://github.com/agjohnson>`__: Bump common to include docker task changes (`#7597 <https://github.com/readthedocs/readthedocs.org/pull/7597>`__)
+* `@agjohnson <https://github.com/agjohnson>`__: Default to sphinx theme 0.5.0 when defaulting to latest sphinx (`#7596 <https://github.com/readthedocs/readthedocs.org/pull/7596>`__)
+* `@humitos <https://github.com/humitos>`__: Use correct Cache-Tag (CDN) and X-RTD-Project header on subprojects (`#7593 <https://github.com/readthedocs/readthedocs.org/pull/7593>`__)
+* `@davidfischer <https://github.com/davidfischer>`__: Ads JS hotfix (`#7586 <https://github.com/readthedocs/readthedocs.org/pull/7586>`__)
+* `@agjohnson <https://github.com/agjohnson>`__: Add remoterepo query param (`#7580 <https://github.com/readthedocs/readthedocs.org/pull/7580>`__)
+* `@agjohnson <https://github.com/agjohnson>`__: Undeprecate APIv2 in docs (`#7579 <https://github.com/readthedocs/readthedocs.org/pull/7579>`__)
+* `@agjohnson <https://github.com/agjohnson>`__: Add settings and docker configuration for working with new theme (`#7578 <https://github.com/readthedocs/readthedocs.org/pull/7578>`__)
+* `@stsewd <https://github.com/stsewd>`__: Search: exclude chagelog from results (`#7570 <https://github.com/readthedocs/readthedocs.org/pull/7570>`__)
+* `@stsewd <https://github.com/stsewd>`__: Search: better results for single terms (`#7569 <https://github.com/readthedocs/readthedocs.org/pull/7569>`__)
+* `@stsewd <https://github.com/stsewd>`__: Search: refactor query objects (`#7568 <https://github.com/readthedocs/readthedocs.org/pull/7568>`__)
+* `@humitos <https://github.com/humitos>`__: Add our `readthedocs_processor` data to our notifications (`#7565 <https://github.com/readthedocs/readthedocs.org/pull/7565>`__)
+* `@stsewd <https://github.com/stsewd>`__: Update ES to 6.8.12 (`#7559 <https://github.com/readthedocs/readthedocs.org/pull/7559>`__)
+* `@stsewd <https://github.com/stsewd>`__: Builds: always install latest version of our sphinx extension (`#7542 <https://github.com/readthedocs/readthedocs.org/pull/7542>`__)
+* `@stsewd <https://github.com/stsewd>`__: Bring back project privacy level (`#7525 <https://github.com/readthedocs/readthedocs.org/pull/7525>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Add future default true to Feature flags (`#7524 <https://github.com/readthedocs/readthedocs.org/pull/7524>`__)
+* `@stsewd <https://github.com/stsewd>`__: Add feature flag to not install the latest version of pip (`#7522 <https://github.com/readthedocs/readthedocs.org/pull/7522>`__)
+* `@davidfischer <https://github.com/davidfischer>`__: No longer proxy RTD ads through RTD servers (`#7506 <https://github.com/readthedocs/readthedocs.org/pull/7506>`__)
+* `@stsewd <https://github.com/stsewd>`__: Subprojects: fix form (`#7491 <https://github.com/readthedocs/readthedocs.org/pull/7491>`__)
+* `@AvdN <https://github.com/AvdN>`__: correct inconsistent indentation of YAML (`#7459 <https://github.com/readthedocs/readthedocs.org/pull/7459>`__)
+
 Version 5.6.0
 -------------
 

CHANGELOG.rst

@@ -60,10 +60,9 @@ when you push to GitHub.
 #. All done.  Commit away and your project will auto-update.
 
 
-.. |build-status| image:: https://img.shields.io/travis/readthedocs/readthedocs.org.svg?style=flat
+.. |build-status| image:: https://circleci.com/gh/readthedocs/readthedocs.org.svg?style=svg
     :alt: build status
-    :scale: 100%
-    :target: https://travis-ci.org/readthedocs/readthedocs.org
+    :target: https://circleci.com/gh/readthedocs/readthedocs.org
 
 .. |docs| image:: https://readthedocs.org/projects/docs/badge/?version=latest
     :alt: Documentation Status

README.rst

@@ -1,19 +1,24 @@
-API v2 (deprecated)
-===================
+API v2
+======
 
 The Read the Docs API uses :abbr:`REST (Representational State Transfer)`.
 JSON is returned by all API responses including errors
 and HTTP response status codes are to designate success and failure.
 
-.. note::
+.. warning::
 
-    A newer and better API v3 is ready to use.
-    Some improvements coming in v3 are:
+    API v2 is planned to be deprecated soon, though we have not yet set a time
+    frame for deprecation yet. We will alert users with our plans when we do.
+
+    For now, API v2 is still used by some legacy application operations still,
+    but we highly recommend Read the Docs users use :doc:`API v3 </api/v3>`
+    instead.
+
+    Some improvements in :doc:`API v3 </api/v3>` are:
 
-    * Simpler URLs which use slugs
     * Token based authentication
-    * Import a new project
-    * Activate a version
+    * Easier to use URLs which no longer use numerical ids
+    * More common user actions are exposed through the API
     * Improved error reporting
 
     See its full documentation at :doc:`/api/v3`.

common

@@ -35,4 +35,5 @@ Advertising-free
    organizations
    single-sign-on
    sharing
+   privacy-level
    analytics

docs/api/v2.rst

@@ -0,0 +1,20 @@
+Project Privacy Level
+---------------------
+
+.. note::
+
+   This feature only exists on `Read the Docs for Business <https://readthedocs.com/>`__.
+
+By default, only users that belong to your organization can see the dashboard of your project and its builds.
+If you want users outside your organization and anonymous users to be able to see the dashboard of your project,
+and the build output of *public versions* you can set the privacy level of your project to ``Public``.
+
+- Go the :guilabel:`Admin` tab of your project.
+- Click on :guilabel:`Advanced Settings`.
+- Change to :guilabel:`Privacy level` to `Public`.
+
+
+.. note::
+
+   To control access to the documentation itself,
+   see :ref:`versions:privacy levels`.

docs/commercial/index.rst

@@ -114,16 +114,16 @@ Configuration of the Python environment to be used.
    version: 2
 
    python:
-      version: 3.7
-      install:
-         - requirements: docs/requirements.txt
-         - method: pip
-           path: .
-           extra_requirements:
-               - docs
-         - method: setuptools
-           path: another/package
-      system_packages: true
+     version: 3.7
+     install:
+       - requirements: docs/requirements.txt
+       - method: pip
+         path: .
+         extra_requirements:
+           - docs
+       - method: setuptools
+         path: another/package
+     system_packages: true
 
 python.version
 ``````````````
@@ -165,10 +165,10 @@ Example:
    version: 2
 
    python:
-      version: 3.7
-      install:
-         - requirements: docs/requirements.txt
-         - requirements: requirements.txt
+     version: 3.7
+     install:
+       - requirements: docs/requirements.txt
+       - requirements: requirements.txt
 
 .. warning::
 
@@ -213,14 +213,14 @@ Example:
    version: 2
 
    python:
-      version: 3.7
-      install:
-         - method: pip
-           path: .
-           extra_requirements:
-              - docs
-         - method: setuptools
-           path: package
+     version: 3.7
+     install:
+       - method: pip
+         path: .
+         extra_requirements:
+           - docs
+       - method: setuptools
+         path: package
 
 With the previous settings, Read the Docs will execute the next commands:
 
@@ -400,8 +400,8 @@ VCS submodules configuration.
 
    submodules:
      include:
-        - one
-        - two
+       - one
+       - two
      recursive: true
 
 submodules.include
@@ -465,11 +465,11 @@ Settings for more control over :doc:`/server-side-search`.
    version: 2
 
    search:
-      ranking:
-        api/v1/*: -1
-        api/v2/*: 4
-      ignore:
-        - 404.html
+     ranking:
+       api/v1/*: -1
+       api/v2/*: 4
+     ignore:
+       - 404.html
 
 search.ranking
 ``````````````
@@ -500,15 +500,15 @@ check :ref:`config-file/v2:search.ignore`.
    version: 2
 
    search:
-      ranking:
-        # Match a single file
-        tutorial.html: 2
+     ranking:
+       # Match a single file
+       tutorial.html: 2
 
-        # Match all files under the api/v1 directory
-        api/v1/*: -5
+       # Match all files under the api/v1 directory
+       api/v1/*: -5
 
-        # Match all files that end with tutorial.html
-        '*/tutorial.html': 3
+       # Match all files that end with tutorial.html
+       '*/tutorial.html': 3
 
 .. note::
 

docs/commercial/privacy-level.rst

@@ -111,6 +111,9 @@ Private versions are available only to people who have permissions to see them.
 They will not display on any list view, and will 404 when you link them to others.
 If you want to share your docs temporarily, see :doc:`/commercial/sharing`.
 
+In addition, if you want other users to view the build page of your public versions,
+you'll neeed to the set the :doc:`privacy level of your project </commercial/privacy-level>` to public.
+
 Tags and branches
 -----------------
 

docs/config-file/v2.rst

@@ -380,6 +380,9 @@ class RemoteRepositoryViewSet(viewsets.ReadOnlyModelViewSet):
 
     def get_queryset(self):
         query = self.model.objects.api(self.request.user)
+        full_name = self.request.query_params.get('full_name')
+        if full_name is not None:
+            query = query.filter(full_name__icontains=full_name)
         org = self.request.query_params.get('org', None)
         if org is not None:
             query = query.filter(organization__pk=org)

docs/versions.rst

@@ -346,7 +346,13 @@ def install_core_requirements(self):
 
         # Install latest pip first,
         # so it is used when installing the other requirements.
-        cmd = pip_install_cmd + ['pip']
+        pip_version = self.project.get_feature_value(
+            Feature.DONT_INSTALL_LATEST_PIP,
+            # 20.3 uses the new resolver by default.
+            positive='pip<20.3',
+            negative='pip',
+        )
+        cmd = pip_install_cmd + [pip_version]
         self.build_env.run(
             *cmd, bin_path=self.venv_bin(), cwd=self.checkout_path
         )
@@ -380,11 +386,17 @@ def install_core_requirements(self):
                     positive='sphinx',
                     negative='sphinx<2',
                 ),
-                'sphinx-rtd-theme<0.5',
+                # If defaulting to Sphinx 2+, we need to push the latest theme
+                # release as well. `<0.5.0` is not compatible with Sphinx 2+
+                self.project.get_feature_value(
+                    Feature.USE_SPHINX_LATEST,
+                    positive='sphinx-rtd-theme',
+                    negative='sphinx-rtd-theme<0.5',
+                ),
                 self.project.get_feature_value(
                     Feature.USE_SPHINX_RTD_EXT_LATEST,
                     positive='readthedocs-sphinx-ext',
-                    negative='readthedocs-sphinx-ext<1.1',
+                    negative='readthedocs-sphinx-ext<2.2',
                 ),
             ])