Merge branch 'master' into using-defaults

Author: stsewd

.github/mergeable.yml

@@ -0,0 +1,28 @@
+# ProBot Mergeable Bot
+# https://github.com/jusx/mergeable
+
+mergeable:
+  pull_requests:
+    approvals:
+      # Minimum of approvals needed.
+      min: 1
+        message: 'The PR must have a minimum of 1 approvals.'
+
+    description:
+      no_empty:
+        # Do not allow empty descriptions on PR.
+        enabled: false
+        message: 'Description can not be empty.'
+
+      must_exclude:
+        # Do not allow 'DO NOT MERGE' phrase on PR's description.
+        regex: 'DO NOT MERGE'
+        message: 'Description says that the PR should not be merged yet.'
+
+    # Do not allow 'WIP' on PR's title.
+    title: 'WIP'
+
+    label:
+      # Do not allow PR with label 'PR: work in progress'
+      must_exclude: 'PR: work in progress'
+      message: 'This PR is work in progress.'

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2017 Read the Docs, Inc & contributors
+Copyright (c) 2010-2019 Read the Docs, Inc & contributors
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

docs/webhooks.rst

@@ -161,9 +161,9 @@ that your VCS provider is not configured correctly. If there is payload
 information on your Read the Docs project, you might need to verify that your
 versions are configured to build correctly.
 
-Either way, it may help to either resync your webhook intergration (see
+Either way, it may help to either resync your webhook integration (see
 `Resyncing webhooks`_ for information on this process), or set up an entirely
-new webhook intergration.
+new webhook integration.
 
 .. _webhook-github-services:
 
@@ -180,7 +180,7 @@ In order for your project to continue automatically building, you will need to
 configure your GitHub repository with a new webhook. You can use either a
 connected GitHub account and a :ref:`GitHub webhook integration <webhook-integration-github>`
 on your Read the Docs project, or you can use a
-:ref:`generic webhook integraiton <webhook-integration-generic>` without a connected
+:ref:`generic webhook integration <webhook-integration-generic>` without a connected
 account.
 
 .. [1] https://developer.github.com/changes/2018-04-25-github-services-deprecation/

readthedocs/config/config.py

@@ -6,7 +6,6 @@
 from __future__ import division, print_function, unicode_literals
 
 import os
-import re
 from contextlib import contextmanager
 
 import six
@@ -23,7 +22,6 @@
     validate_bool,
     validate_choice,
     validate_dict,
-    validate_directory,
     validate_file,
     validate_list,
     validate_string,
@@ -44,12 +42,8 @@
 
 CONFIG_NOT_SUPPORTED = 'config-not-supported'
 VERSION_INVALID = 'version-invalid'
-BASE_INVALID = 'base-invalid'
-BASE_NOT_A_DIR = 'base-not-a-directory'
 CONFIG_SYNTAX_INVALID = 'config-syntax-invalid'
 CONFIG_REQUIRED = 'config-required'
-NAME_REQUIRED = 'name-required'
-NAME_INVALID = 'name-invalid'
 CONF_FILE_REQUIRED = 'conf-file-required'
 PYTHON_INVALID = 'python-invalid'
 SUBMODULES_INVALID = 'submodules-invalid'
@@ -252,12 +246,6 @@ class BuildConfigV1(BuildConfigBase):
 
     """Version 1 of the configuration file."""
 
-    BASE_INVALID_MESSAGE = 'Invalid value for base: {base}'
-    BASE_NOT_A_DIR_MESSAGE = '"base" is not a directory: {base}'
-    NAME_REQUIRED_MESSAGE = 'Missing key "name"'
-    NAME_INVALID_MESSAGE = (
-        'Invalid name "{name}". Valid values must match {name_re}'
-    )
     CONF_FILE_REQUIRED_MESSAGE = 'Missing key "conf_file"'
     PYTHON_INVALID_MESSAGE = '"python" section must be a mapping.'
     PYTHON_EXTRA_REQUIREMENTS_INVALID_MESSAGE = (
@@ -295,63 +283,17 @@ def validate(self):
           ``readthedocs.yml`` config file if not set
         """
         # Validate env_config.
-        # TODO: this isn't used
-        self._config['output_base'] = self.validate_output_base()
-
         # Validate the build environment first
         # Must happen before `validate_python`!
         self._config['build'] = self.validate_build()
 
         # Validate raw_config. Order matters.
-        # TODO: this isn't used
-        self._config['name'] = self.validate_name()
-        # TODO: this isn't used
-        self._config['base'] = self.validate_base()
         self._config['python'] = self.validate_python()
         self._config['formats'] = self.validate_formats()
 
         self._config['conda'] = self.validate_conda()
         self._config['requirements_file'] = self.validate_requirements_file()
 
-    def validate_output_base(self):
-        """Validates that ``output_base`` exists and set its absolute path."""
-        assert 'output_base' in self.env_config, (
-               '"output_base" required in "env_config"')
-        output_base = os.path.abspath(
-            os.path.join(
-                self.env_config.get('output_base', self.base_path),
-            )
-        )
-        return output_base
-
-    def validate_name(self):
-        """Validates that name exists."""
-        name = self.raw_config.get('name', None)
-        if not name:
-            name = self.env_config.get('name', None)
-        if not name:
-            self.error('name', self.NAME_REQUIRED_MESSAGE, code=NAME_REQUIRED)
-        name_re = r'^[-_.0-9a-zA-Z]+$'
-        if not re.match(name_re, name):
-            self.error(
-                'name',
-                self.NAME_INVALID_MESSAGE.format(
-                    name=name,
-                    name_re=name_re),
-                code=NAME_INVALID)
-
-        return name
-
-    def validate_base(self):
-        """Validates that path is a valid directory."""
-        if 'base' in self.raw_config:
-            base = self.raw_config['base']
-        else:
-            base = self.base_path
-        with self.catch_validation_error('base'):
-            base = validate_directory(base, self.base_path)
-        return base
-
     def validate_build(self):
         """
         Validate the build config settings.
@@ -525,21 +467,6 @@ def validate_formats(self):
 
         return formats
 
-    @property
-    def name(self):
-        """The project name."""
-        return self._config['name']
-
-    @property
-    def base(self):
-        """The base directory."""
-        return self._config['base']
-
-    @property
-    def output_base(self):
-        """The output base."""
-        return self._config['output_base']
-
     @property
     def formats(self):
         """The documentation formats to be built."""