Merge branch 'master' into use-latest-setuptools

Author: stsewd

.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

.readthedocs.yml

@@ -18,3 +18,4 @@ search:
 
     # Useful content, but not something we want most users finding
     custom_installs/*: -6
+    changelog.html: -6

.travis.yml

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

CHANGELOG.rst

@@ -49,6 +49,8 @@ RUN if [ -n "$GITHUB_TOKEN" ] ; \
         then \
         git clone --depth 1 https://${GITHUB_TOKEN}@github.com/readthedocs/readthedocs-ext ; \
         pip3 install --no-cache-dir -e readthedocs-ext ; \
+        git clone --depth 1 https://${GITHUB_TOKEN}@github.com/readthedocs/ext-theme ; \
+        pip3 install --no-cache-dir -e ext-theme ; \
         fi
 
 WORKDIR /usr/src/app/checkouts/readthedocs.org

README.rst

@@ -19,10 +19,13 @@ as our way of saying thanks to the open source community.
 We talk a bit below about :ref:`our worldview on advertising <advertising/ethical-advertising:Our Worldview>`,
 if you want to know more.
 
-.. important::
+.. admonition:: Are you a marketer?
+
+    We built a `whole business <https://www.ethicalads.io/?ref=rtd-docs>`_
+    around privacy-focused advertising.
+    If you're trying to reach developers, we have a network of hand-approved sites (including Read the Docs)
+    where your ads are shown.
 
-   **Are you a marketer?**
-   `Learn more <https://readthedocs.org/sustainability/advertising/>`_ about how you can connect with the millions of developers who Read the Docs each month.
 
 Feedback
 --------
@@ -107,9 +110,10 @@ Additional details
   `talks a bit more <https://www.ericholscher.com/blog/2016/aug/31/funding-oss-marketing-money/>`_
   about funding open source this way on his blog.
 * After proving our ad model as a way to fund open source and building our ad serving infrastructure,
-  we launched the `EthicalAds network <https://www.ethicalads.io>`_ to help other projects be sustainable.
+  we launched the `EthicalAds network <https://www.ethicalads.io?ref=rtd-docs>`_
+  to help other projects be sustainable.
 
-.. _advertising FAQ: https://readthedocs.org/sustainability/advertising/faq/
+.. _advertising FAQ: https://www.ethicalads.io/advertisers/faq/?ref=rtd-docs
 
 Join us
 -------
@@ -121,7 +125,7 @@ We hope that others will join us in this mission:
   `talk to your marketing folks <https://www.ericholscher.com/blog/2016/aug/31/funding-oss-marketing-money/>`_ about using advertising that respects your privacy.
 * **If you're a marketer**,
   vote with your dollars and support us in building the ad model we want to exist.
-  `Get more information <https://readthedocs.org/sustainability/advertising/>`_ on what we offer.
+  `Get more information <https://www.ethicalads.io/advertisers/?ref=rtd-docs>`_ on what we offer.
 
 
 Community Ads

common

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

dockerfiles/Dockerfile

@@ -412,6 +412,10 @@ Versions listing
 
     :query boolean active: return only active versions
     :query boolean built: return only built versions
+    :query string privacy_level: return versions with specific privacy level (``public`` or ``private``)
+    :query string slug: return versions with matching slug
+    :query string type: return versions with specific type (``branch`` or ``tag``)
+    :query string verbose_name: return versions with matching version name
 
 
 Version detail

docs/advertising/ethical-advertising.rst

@@ -61,6 +61,16 @@ Currently, the following actions are available:
   i.e. the version of your project that `/` redirects to.
   See more in :ref:`automatic-redirects:Root URL`.
   It also activates and builds the version.
+- **Delete version**: When a branch or tag is deleted from your repository,
+  Read the Docs will delete it *only if isn't active*.
+  This action allows you to delete *active* versions when a branch or tag is deleted from your repository.
+
+  .. note::
+
+     The default version isn't deleted even if it matches a rule.
+     You can use the ``Set version as default`` action to change the default version
+     before deleting the current one.
+
 
 .. note::
 
@@ -99,6 +109,13 @@ Activate only new branches that belong to the ``1.x`` release
 - Version type: ``Branch``
 - Action: ``Activate version``
 
+Delete an active version when a branch is deleted
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Match: ``Any version``
+- Version type: ``Branch``
+- Action: ``Delete version``
+
 Set as default new tags that have the ``-stable`` or ``-release`` suffix
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

docs/api/v2.rst

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

docs/api/v3.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`.