Merge branch 'master' into humitos/use-mamba-for-conda-environment

Author: humitos

.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

@@ -3,5 +3,19 @@ formats: all
 sphinx:
   configuration: docs/conf.py
 python:
-   install:
-      - requirements: requirements/local-docs-build.txt
+  install:
+    - requirements: requirements/pip.txt
+    - requirements: requirements/docs.txt
+
+search:
+  ranking:
+    # Deprecated content
+    api/v1.html: -1
+    config-file/v1.html: -1
+
+    # Internal documentation
+    development/design/*: -5
+
+    # 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
@@ -78,6 +77,6 @@ when you push to GitHub.
 License
 -------
 
-`MIT`_ © 2010-2019 Read the Docs, Inc & contributors
+`MIT`_ © 2010-2020 Read the Docs, Inc & contributors
 
 .. _MIT: LICENSE

CHANGELOG.rst

@@ -84,6 +84,8 @@ services:
     image: microsoft/azure-cli
     volumes:
       - ${PWD}/common/dockerfiles/scripts/create-containers.sh:/usr/local/bin/create-containers.sh
+    environment:
+      - INIT=${INIT:-}
     links:
       - storage
     depends_on:

README.rst

@@ -39,8 +39,8 @@ RUN ln -s /usr/bin/python3 /usr/bin/python
 
 WORKDIR /tmp
 
-RUN curl -O https://raw.githubusercontent.com/readthedocs/readthedocs.org/master/requirements/pip.txt
-RUN curl -O https://raw.githubusercontent.com/readthedocs/readthedocs.org/master/requirements/docker.txt
+COPY requirements/pip.txt pip.txt
+COPY requirements/docker.txt docker.txt
 RUN pip3 install --no-cache-dir -r docker.txt
 
 # Install readthedocs-ext only if GITHUB_TOKEN is provided
@@ -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

common

@@ -24,8 +24,8 @@ server {
         proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
         proxy_set_header X-Forwarded-Host $host;
 
-        proxy_intercept_errors on;  
-        error_page 404 = @proxito404;
+        proxy_intercept_errors on;
+        error_page 404 = @notfoundfallback;
 
         add_header X-Served Django-Proxito always;
     }
@@ -56,8 +56,16 @@ server {
         add_header X-RTD-Path $rtd_path always;
         set $rtd_domain $upstream_http_x_rtd_domain;
         add_header X-RTD-Domain $rtd_domain always;
-        set $rtd_method $upstream_http_x_rtd_version_method;
-        add_header X-RTD-Version-Method $rtd_method always;
+        set $rtd_version_method $upstream_http_x_rtd_version_method;
+        add_header X-RTD-Version-Method $rtd_version_method always;
+        set $rtd_project_method $upstream_http_x_rtd_project_method;
+        add_header X-RTD-Project-Method $rtd_project_method always;
+        set $rtd_redirect $upstream_http_x_rtd_redirect;
+        add_header X-RTD-Redirect $rtd_redirect always;
+        set $cache_tag $upstream_http_cache_tag;
+        add_header Cache-Tag $cache_tag always;
+        set $referrer_policy $upstream_http_referrer_policy;
+        add_header Referrer-Policy $referrer_policy always;
     }
 
     # Serve 404 pages here

docker-compose.override.yml

@@ -9,14 +9,6 @@ server {
         break;
     }
 
-    # FIXME: this is a workaround because CORS on the storage.
-    # The command to enable it is failing without reason:
-    # pip install azure-cli
-    # AZURE_STORAGE_CONNECTION_STRING="UseDevelopmentStorage=true" az storage cors add --origins 'community.dev.readthedocs.io' --services 'b' --methods GET OPTIONS HEAD --allowed-headers '*'
-    location /devstoreaccount1 {
-        proxy_pass http://storage:10000$request_uri;
-    }
-
     location / {
         proxy_pass http://web:8000/;
         proxy_set_header X-Forwarded-Host $host;

dockerfiles/Dockerfile

@@ -2,7 +2,12 @@
 
 
 class WebDevSettings(DockerBaseSettings):
-    pass
+
+    # Router is useful from webs only because they have access to the database.
+    # Builders will use the same queue that was assigned the first time on retry
+    CELERY_ROUTES = (
+        'readthedocs.builds.tasks.TaskRouter',
+    )
 
 
 WebDevSettings.load_settings(__name__)

dockerfiles/nginx/proxito.conf

@@ -1,6 +1,7 @@
 [rstcheck]
 ignore_directives=automodule,http:get,tabs,tab,prompt,http:patch,http:post,http:put,http:delete
 ignore_roles=djangosetting,setting,featureflags,buildpyversions
+ignore_substitutions=org_brand,com_brand,:smile:
 # This error needs to be ignored for now
 # See: https://github.com/myint/rstcheck/issues/19
 ignore_messages=(Hyperlink target ".*" is not referenced)

dockerfiles/nginx/web.conf

@@ -4,3 +4,9 @@ def setup(app):
         rolename="setting",
         indextemplate="pair: %s; setting",
     )
+
+    return {
+        'version': 'builtin',
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }

dockerfiles/settings/web.py

@@ -0,0 +1,17 @@
+/*
+ * Expands a specific tab of sphinx-tabs.
+ * Usage:
+ * - docs.readthedocs.io/?tab=Name
+ * - docs.readthedocs.io/?tab=Name#section
+ * Where 'Name' is the title of the tab (case sensitive).
+*/
+$( document ).ready(function() {
+  const urlParams = new URLSearchParams(window.location.search);
+  const tabName = urlParams.get('tab');
+  if (tabName !== null) {
+    const tab = $('a.item > div:contains("' + tabName + '")');
+    if (tab.length > 0) {
+      tab.click();
+    }
+  }
+});

docs/.rstcheck.cfg

@@ -0,0 +1,27 @@
+About Read the Docs
+===================
+
+Read the Docs is a C Corporation registered in Oregon.
+Our bootstrapped company is owned and fully controlled by the founders,
+and fully funded by our customers and advertisers.
+This allows us to **focus 100% on our users**. 
+
+We have two main sources of revenue:
+
+* |com_brand| - where we `provide <https://readthedocs.com>`__ a valuable paid service to companies.
+* |org_brand| - where we provide a free service to the open source community, funded via :doc:`/advertising/ethical-advertising`.
+
+We believe that having both paying customers and ethical advertising is the best way to create a sustainable platform for our users.
+We have built something that we expect to last a long time,
+and we are able to make decisions based only on the best interest of our community and customers.
+
+All of the source code for Read the Docs is open source.
+You are welcome to :doc:`contribute </contribute>` the features you want or run your own instance.
+We should note that we generally only support our hosted versions as a matter of :doc:`our philosophy </open-source-philosophy>`.
+
+We owe a great deal to the open source community that we are a part of,
+so we provide free ads via our :ref:`community ads <advertising/ethical-advertising:Community Ads>` program.
+This allows us to give back to the communities and projects that we support and depend on.
+
+We are proud about the way we manage our company and products,
+and are glad to have you on board with us in this :doc:`great documentation journey </story>`.

docs/_ext/djangodocs.py

@@ -38,8 +38,8 @@ In Sphinx, this is typically done by
 adding a new template (under `templates_path`_)
 for inclusion in the `HTML sidebar`_ in your ``conf.py``.
 
-.. _HTML sidebar: http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_sidebars
-.. _templates_path: http://www.sphinx-doc.org/en/master/usage/configuration.html#confval-templates_path
+.. _HTML sidebar: https://www.sphinx-doc.org/page/usage/configuration.html#confval-html_sidebars
+.. _templates_path: https://www.sphinx-doc.org/page/usage/configuration.html#confval-templates_path
 
 .. code-block:: python
 

docs/_static/images/development/bitbucket-oauth-setup.png

@@ -71,8 +71,6 @@ Instead, we target based solely upon:
     targeting by state or by metro area (DMA specifically).
   * We geolocate a user's IP address to a country when a request is made.
 
-Read the Docs uses GeoLite2 data created by `MaxMind <http://maxmind.com>`_.
-
 
 Where ads are shown
 -------------------
@@ -97,6 +95,14 @@ For more details, see the :ref:`Do Not Track section <privacy-policy:Do Not Trac
 of our privacy policy.
 
 
+Ad serving infrastructure
+-------------------------
+
+Our `entire ad server <https://github.com/readthedocs/ethical-ad-server>`_ is open source,
+so you can inspect how we're doing things.
+We believe strongly in open source, and we practice what we preach.
+
+
 Analytics
 ---------
 
@@ -118,6 +124,9 @@ These steps apply both to analytics collected by Read the Docs and when
 * Users can opt-out of analytics by using the Do Not Track feature of their browser.
 * Read the Docs instructs Google to anonymize IP addresses sent to them.
 * The cookies set by GA expire in 30 days rather than the default 2 years.
+* Project maintainers can completely disable analytics on their own projects.
+  Follow the steps in :ref:`guides/google-analytics:Disabling Google Analytics on your project`.
+
 
 Why we use analytics
 ~~~~~~~~~~~~~~~~~~~~