Merge branch 'master' into trigger-build-default-branch

Author: dojutsu-user

conftest.py

@@ -47,6 +47,12 @@ def pytest_configure(config):
 def settings_modification(settings):
     settings.CELERY_ALWAYS_EAGER = True
 
+
 @pytest.fixture
 def api_client():
     return APIClient()
+
+
+@pytest.fixture(scope="class")
+def url_scheme(request):
+    request.cls.url_scheme = request.config.option.url_scheme

docs/builds.rst

@@ -9,8 +9,8 @@ Files: `tasks.py`_ - `doc_builder/`_
 Every documentation build has limited resources.
 Our current build limits are:
 
-* 15 minutes
-* 1GB of memory
+* 15 minutes of CPU
+* 1GB of RAM memory
 
 We can increase build limits on a per-project basis,
 if you provide a good reason your documentation needs more resources.
@@ -73,8 +73,9 @@ If the code is already checked out, we update the copy to the branch that you ha
 
 Then we build the proper backend code for the type of documentation you've selected.
 
-If you have the *Install Project* option enabled, we will run ``setup.py install`` on your package, installing it into a virtual environment.
-You can also define additional packages to install with the *Requirements File* option.
+At this point, if you need extra requirements,
+or even install your own package in the virtual environment to build your documentation,
+you can use a :doc:`config-file/index`.
 
 When we build your Sphinx documentation, we run ``sphinx-build -b html . _build/html``,
 where ``html`` would be replaced with the correct backend.
@@ -89,13 +90,17 @@ An example in code:
 .. code-block:: python
 
     update_docs_from_vcs(version)
-    if exists('setup.py'):
+    config = get_config(project)
+    if config.python.install.method.setuptools:
         run('python setup.py install')
-    if project.requirements_file:
-        run('pip install -r %s' % project.requirements_file)
+    if config.python.install.method.pip:
+        run('pip install .')
+    if config.python.install.requirement:
+        run('pip install -r %s' % config.python.install.requirement)
     build_docs(version=version)
     copy_files(artifact_dir)
 
+
 .. note::
 
     Regardless of whether you build your docs with Sphinx or MkDocs,
@@ -179,4 +184,5 @@ The *Sphinx* and *Mkdocs* builders set the following RTD-specific environment va
 .. tip::
 
    In case extra environment variables are needed to the build process (like secrets, tokens, etc),
-   you can add them going to **Admin > Environment Variables** in your project. See :doc:`guides/environment-variables`.
+   you can add them going to :guilabel:`Admin` > :guilabel:`Environment Variables` in your project.
+   See :doc:`guides/environment-variables`.

docs/custom_domains.rst

@@ -60,7 +60,7 @@ FAQ <https://support.cloudflare.com/hc/en-us/articles/115000310832-Certification
     Some older setups configured a CNAME record pointing to ``readthedocs.org``
     or another variation. While these continue to resolve,
     they do not yet allow us to acquire SSL certificates for those domains.
-    Point the CNAME to ``readthedocs.io`` and re-request a certificate
+    Point the CNAME to ``readthedocs.io``, with no subdomain, and re-request a certificate
     by saving the domain in the project admin (:guilabel:`Domains` >
     :guilabel:`Edit Domain`).
 

readthedocs/doc_builder/python_environments.py

@@ -303,7 +303,7 @@ def install_core_requirements(self):
                 self.project.get_feature_value(
                     Feature.USE_SPHINX_LATEST,
                     positive='sphinx<2',
-                    negative='sphinx<1.8',
+                    negative='sphinx<2',
                 ),
                 'sphinx-rtd-theme<0.5',
                 'readthedocs-sphinx-ext<0.6',

readthedocs/rtd_tests/tests/test_core_tags.py

@@ -9,13 +9,14 @@
 from readthedocs.projects.models import Project
 
 
+@pytest.mark.usefixtures("url_scheme")
 @override_settings(USE_SUBDOMAIN=False, PRODUCTION_DOMAIN='readthedocs.org')
 class CoreTagsTests(TestCase):
     fixtures = ['eric', 'test_data']
 
     def setUp(self):
         url_base = '{scheme}://{domain}/docs/pip{{version}}'.format(
-            scheme=pytest.config.option.url_scheme,
+            scheme=self.url_scheme,
             domain=settings.PRODUCTION_DOMAIN,
         )
 

requirements/pip.txt

@@ -1,14 +1,14 @@
 # Base packages
 pip==19.0.3
 appdirs==1.4.3
-virtualenv==16.4.1
+virtualenv==16.4.3
 
 django==1.11.20  # pyup: <1.12
 django-tastypie==0.14.2
 django-guardian==1.5.0
 django-extensions==2.1.6
 
-djangorestframework==3.9.1
+djangorestframework==3.9.2
 
 # For intersphinx during builds
 Sphinx==1.8.4
@@ -22,11 +22,15 @@ jsonfield==2.0.2
 requests==2.21.0
 requests-toolbelt==0.9.1
 slumber==0.7.1
-lxml==4.3.1
-defusedxml==0.5.0
 pyyaml==3.13
 Pygments==2.3.1
 
+# These has to be removed once APIv1 is removed
+# https://github.com/rtfd/readthedocs.org/pull/5293
+# https://github.com/rtfd/readthedocs.org/pull/3082
+lxml==4.3.1
+defusedxml==0.5.0
+
 # Basic tools
 # Redis 3.x has an incompatible change and fails
 # https://stackoverflow.com/questions/53331405/django-compress-error-invalid-input-of-type-cachekey
@@ -36,10 +40,7 @@ redis==2.10.6  # pyup: ignore
 # when ALWAYS_EAGER = True
 celery==4.1.1  # pyup: ignore
 
-django-allauth==0.38.0
-
-# VCS
-httplib2==0.12.1
+django-allauth==0.39.1
 
 # GitPython 2.1.11 makes TestGitBackend.test_git_tags to fail because
 # of an UnicodeError
@@ -65,7 +66,6 @@ pyquery==1.4.0
 # Utils
 django-gravatar2==1.4.2
 pytz==2018.9
-beautifulsoup4==4.7.1
 Unipath==1.1
 django-kombu==0.9.4
 mock==2.0.0