Merge remote-tracking branch 'origin/master' into fix-domain-editing

Author: ericholscher

CHANGELOG.rst

@@ -1,3 +1,22 @@
+Version 2.1.2
+-------------
+
+ * `@agjohnson <http://github.com/agjohnson>`_: Update changelog more consistently (`#3405 <https://github.com/rtfd/readthedocs.org/pull/3405>`_)
+ * `@agjohnson <http://github.com/agjohnson>`_: Update prerelease invoke command to call with explicit path (`#3404 <https://github.com/rtfd/readthedocs.org/pull/3404>`_)
+ * `@agjohnson <http://github.com/agjohnson>`_: Fix lint error (`#3402 <https://github.com/rtfd/readthedocs.org/pull/3402>`_)
+ * `@stsewd <http://github.com/stsewd>`_: Remove copyright application (`#3400 <https://github.com/rtfd/readthedocs.org/pull/3400>`_)
+ * `@humitos <http://github.com/humitos>`_: Show connect buttons for installed apps only (`#3394 <https://github.com/rtfd/readthedocs.org/pull/3394>`_)
+ * `@agjohnson <http://github.com/agjohnson>`_: Don't display the build suggestions div if there are no suggestions (`#3389 <https://github.com/rtfd/readthedocs.org/pull/3389>`_)
+ * `@jonrkarr <http://github.com/jonrkarr>`_: Error in YAML configuration docs: default value for `python.setup_py_install` should be `true` (`#3334 <https://github.com/rtfd/readthedocs.org/issues/3334>`_)
+ * `@humitos <http://github.com/humitos>`_: Simple task to finish inactive builds (`#3312 <https://github.com/rtfd/readthedocs.org/pull/3312>`_)
+ * `@agjohnson <http://github.com/agjohnson>`_: Cleanup misreported failed builds (`#3230 <https://github.com/rtfd/readthedocs.org/issues/3230>`_)
+ * `@agjohnson <http://github.com/agjohnson>`_: Remove copyright application (`#3199 <https://github.com/rtfd/readthedocs.org/issues/3199>`_)
+
+Version 2.1.1
+-------------
+
+Release information missing
+
 Version 2.1.0
 -------------
 

docs/abandoned-projects.rst

@@ -3,100 +3,91 @@ Policy for Abandoned Projects
 
 This policy describes the process by which a Read the Docs project name may be changed.
 
-
 Rationale
 ---------
 
 Conflict between the current use of the name and a different suggested use of
 the same name occasionally arise.  This document aims to provide general
 guidelines for solving the most typical cases of such conflicts.
 
-
 Specification
 -------------
 
 The main idea behind this policy is that Read the Docs serves the community.  Every
 user is invited to upload content under the Terms of Use, understanding that it
 is at the sole risk of the user.
 
-While Read the Docs is not a backup service, the maintainers do their best to keep that
-content accessible indefinitely in its published form.  However, in certain
+While Read the Docs is not a backup service, the core team of Read the Docs does their best to keep that
+content accessible indefinitely in its published form. However, in certain
 edge cases the greater community's needs might outweigh the individual's
 expectation of ownership of a project name.
 
 The use cases covered by this policy are:
 
-* Abandoned projects:
-
-    * renaming a project so that the original project name can be used by a
-      different project.
-
-* Active projects:
-
-    * resolving disputes over a name.
+Abandoned projects
+    Renaming a project so that the original project name can be used by a
+    different project
 
+Active projects
+    Resolving disputes over a name
 
 Implementation
 --------------
 
 Reachability
 ~~~~~~~~~~~~
 
-The user of Read the Docs is solely responsible for being reachable by the maintainers
-for matters concerning projects that the user owns.  In every case where
-contacting the user is necessary, the maintainers will try to do so at least
+The user of Read the Docs is solely responsible for being reachable by the core team
+for matters concerning projects that the user owns. In every case where
+contacting the user is necessary, the core team will try to do so at least
 three times, using the following means of contact:
 
-* e-mail address on file in the user's profile;
-* e-mail addresses found in the given project's documentation; and
-* e-mail address on the project's home page.
+* E-mail address on file in the user's profile
+* E-mail addresses found in the given project's documentation
+* E-mail address on the project's home page
 
-The maintainers will stop trying to reach the user after six weeks and the user
+The core team will stop trying to reach the user after six weeks and the user
 will be considered *unreachable*.
 
-
 Abandoned projects
 ~~~~~~~~~~~~~~~~~~
 
 A project is considered *abandoned* when ALL of the following are met:
 
-* owner is unreachable (see Reachability above);
-* The project has no proper documentation being served (no successful builds); or
-* no releases within the past twelve months; and
-* no activity from the owner on the project's home page (or no home page
+* Owner is unreachable (see `Reachability`_)
+* The project has no proper documentation being served (no successful builds) or
+  does not have any releases within the past twelve months
+* No activity from the owner on the project's home page (or no home page
   found).
 
 All other projects are considered *active*.
 
-
 Renaming of an abandoned project
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 Projects are never renamed solely on the basis of abandonment.
 
-An *abandoned* project can be renamed (by appending "-abandoned" and a
+An *abandoned* project can be renamed (by appending ``-abandoned`` and a
 uniquifying integer if needed) for purposes of reusing the name when ALL of the
 following are met:
 
-* the project has been determined *abandoned* by the rules described above;
-* the candidate is able to demonstrate their own failed attempts to contact the
-  existing owner;
-* the candidate is able to demonstrate that the project suggested to reuse the
-  name already exists and meets notability requirements;
-* the candidate is able to demonstrate why a fork under a different name is not
-  an acceptable workaround;
-* the project has fewer than 100 monthly pageviews; and
-* the maintainers do not have any additional reservations.
-
+* The project has been determined *abandoned* by the rules described above
+* The candidate is able to demonstrate their own failed attempts to contact the
+  existing owner
+* The candidate is able to demonstrate that the project suggested to reuse the
+  name already exists and meets notability requirements
+* The candidate is able to demonstrate why a fork under a different name is not
+  an acceptable workaround
+* The project has fewer than 100 monthly pageviews
+* The core team does not have any additional reservations.
 
 Name conflict resolution for active projects
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-The maintainers of Read the Docs are not arbiters in disputes around *active* projects.
-The maintainers recommend users to get in touch with each other and solve the
+The core team of Read the Docs are not arbiters in disputes around *active* projects.
+The core team recommends users to get in touch with each other and solve the
 issue by respectful communication.
 
-
 Prior art
 ---------
 

docs/talks.rst

@@ -690,19 +690,16 @@ div.project-import-remote button.remote-sync:before {
     content: "\f021";
 }
 
-div.project-import-remote form.import-connect-github button:before,
 a.socialaccount-provider.github:before {
     font-family: FontAwesome;
     content: "\f09b";
 }
 
-div.project-import-remote form.import-connect-gitlab button:before,
 a.socialaccount-provider.gitlab:before {
     font-family: FontAwesome;
-    content: "\f1d3";
+    content: "\f296";
 }
 
-div.project-import-remote form.import-connect-bitbucket button:before,
 a.socialaccount-provider.bitbucket:before,
 a.socialaccount-provider.bitbucket_oauth2:before {
     font-family: FontAwesome;

media/css/core.css

@@ -35,6 +35,15 @@ pep257:
     - D105
     - D211
     - D104
+    - D212  # Multi-line docstring summary should start at the first line
+    - D107  # Missing docstring in __init__
+    - D106  # Missing docstring in public nested class
+
+    # pydocstyle
+    - D406  # Section name should end with a newline ('Examples', not 'Examples::')
+    - D407  # Missing dashed underline after section ('Examples')
+    - D412  # No blank lines allowed between a section header and its content ('Examples')
+    - D413  # Missing blank line after last section ('Examples')
 
 pyflakes:
   disable:

prospector.yml

@@ -16,7 +16,8 @@
 
 class VersionManagerBase(models.Manager):
 
-    """Version manager for manager only queries
+    """
+    Version manager for manager only queries.
 
     For queries not suitable for the :py:cls:`VersionQuerySet`, such as create
     queries.

readthedocs/builds/managers.py

@@ -1,7 +1,8 @@
-"""Classes to copy files between build and web servers
+"""
+Classes to copy files between build and web servers.
 
-"Syncers" copy files from the local machine, while "Pullers" copy files to
-the local machine.
+"Syncers" copy files from the local machine, while "Pullers" copy files to the
+local machine.
 """
 
 from __future__ import absolute_import

readthedocs/builds/syncers.py

@@ -1,4 +1,5 @@
-"""Contains logic for handling version slugs.
+"""
+Contains logic for handling version slugs.
 
 Handling slugs for versions is not too straightforward. We need to allow some
 characters which are uncommon in usual slugs. They are dots and underscores.
@@ -32,8 +33,8 @@ def get_fields_with_model(cls):
     """
     Replace deprecated function of the same name in Model._meta.
 
-    This replaces deprecated function (as of Django 1.10) in
-    Model._meta as prescrived in the Django docs.
+    This replaces deprecated function (as of Django 1.10) in Model._meta as
+    prescrived in the Django docs.
     https://docs.djangoproject.com/en/1.11/ref/models/meta/#migrating-from-the-old-api
     """
     return [

readthedocs/builds/version_slug.py

@@ -1,4 +1,4 @@
-"""Django admin interface for core models"""
+"""Django admin interface for core models."""
 
 from __future__ import absolute_import
 from datetime import datetime, timedelta
@@ -22,7 +22,7 @@ class UserProjectInline(admin.TabularInline):
 
 class UserProjectFilter(admin.SimpleListFilter):
 
-    """Filter users based on project properties"""
+    """Filter users based on project properties."""
 
     parameter_name = 'project_state'
     title = _('user projects')
@@ -39,7 +39,8 @@ def lookups(self, request, model_admin):
         )
 
     def queryset(self, request, queryset):
-        """Add filters to queryset filter
+        """
+        Add filters to queryset filter.
 
         ``PROJECT_ACTIVE`` and ``PROJECT_BUILT`` look for versions on projects,
         ``PROJECT_RECENT`` looks for projects with builds in the last year

readthedocs/core/admin.py

@@ -31,10 +31,11 @@
 
 class SubdomainMiddleware(object):
 
-    """Middleware to display docs for non-dashboard domains"""
+    """Middleware to display docs for non-dashboard domains."""
 
     def process_request(self, request):
-        """Process requests for unhandled domains
+        """
+        Process requests for unhandled domains.
 
         If the request is not for our ``PUBLIC_DOMAIN``, or if ``PUBLIC_DOMAIN``
         is not set and the request is for a subdomain on ``PRODUCTION_DOMAIN``,
@@ -132,22 +133,22 @@ def process_request(self, request):
 
 class SingleVersionMiddleware(object):
 
-    """Reset urlconf for requests for 'single_version' docs.
-
-    In settings.MIDDLEWARE_CLASSES, SingleVersionMiddleware must follow
-    after SubdomainMiddleware.
+    """
+    Reset urlconf for requests for 'single_version' docs.
 
+    In settings.MIDDLEWARE_CLASSES, SingleVersionMiddleware must follow after
+    SubdomainMiddleware.
     """
 
     def _get_slug(self, request):
-        """Get slug from URLs requesting docs.
+        """
+        Get slug from URLs requesting docs.
 
         If URL is like '/docs/<project_name>/', we split path
         and pull out slug.
 
         If URL is subdomain or CNAME, we simply read request.slug, which is
         set by SubdomainMiddleware.
-
         """
         slug = None
         if hasattr(request, 'slug'):
@@ -187,16 +188,16 @@ def process_request(self, request):
 class ProxyMiddleware(object):
 
     """
-    Middleware that sets REMOTE_ADDR based on HTTP_X_FORWARDED_FOR, if the
+    Middleware that sets REMOTE_ADDR based on HTTP_X_FORWARDED_FOR, if the.
 
     latter is set. This is useful if you're sitting behind a reverse proxy that
-    causes each request's REMOTE_ADDR to be set to 127.0.0.1.
-    Note that this does NOT validate HTTP_X_FORWARDED_FOR. If you're not behind
-    a reverse proxy that sets HTTP_X_FORWARDED_FOR automatically, do not use
-    this middleware. Anybody can spoof the value of HTTP_X_FORWARDED_FOR, and
-    because this sets REMOTE_ADDR based on HTTP_X_FORWARDED_FOR, that means
-    anybody can "fake" their IP address. Only use this when you can absolutely
-    trust the value of HTTP_X_FORWARDED_FOR.
+    causes each request's REMOTE_ADDR to be set to 127.0.0.1. Note that this
+    does NOT validate HTTP_X_FORWARDED_FOR. If you're not behind a reverse proxy
+    that sets HTTP_X_FORWARDED_FOR automatically, do not use this middleware.
+    Anybody can spoof the value of HTTP_X_FORWARDED_FOR, and because this sets
+    REMOTE_ADDR based on HTTP_X_FORWARDED_FOR, that means anybody can "fake"
+    their IP address. Only use this when you can absolutely trust the value of
+    HTTP_X_FORWARDED_FOR.
     """
 
     def process_request(self, request):

readthedocs/core/middleware.py

@@ -1,4 +1,4 @@
-"""URL resolver for documentation"""
+"""URL resolver for documentation."""
 
 from __future__ import absolute_import
 from builtins import object
@@ -54,7 +54,7 @@ class ResolverBase(object):
     def base_resolve_path(self, project_slug, filename, version_slug=None,
                           language=None, private=False, single_version=None,
                           subproject_slug=None, subdomain=None, cname=None):
-        """Resolve a with nothing smart, just filling in the blanks"""
+        """Resolve a with nothing smart, just filling in the blanks."""
         # Only support `/docs/project' URLs outside our normal environment. Normally
         # the path should always have a subdomain or CNAME domain
         # pylint: disable=unused-argument
@@ -80,7 +80,7 @@ def base_resolve_path(self, project_slug, filename, version_slug=None,
     def resolve_path(self, project, filename='', version_slug=None,
                      language=None, single_version=None, subdomain=None,
                      cname=None, private=None):
-        """Resolve a URL with a subset of fields defined"""
+        """Resolve a URL with a subset of fields defined."""
         relation = project.superprojects.first()
         cname = cname or project.domains.filter(canonical=True).first()
         main_language_project = project.main_language_project
@@ -145,7 +145,8 @@ def resolve(self, project, protocol='http', filename='', private=None,
         )
 
     def _get_canonical_project(self, project):
-        """Get canonical project in the case of subproject or translations
+        """
+        Get canonical project in the case of subproject or translations.
 
         :type project: Project
         :rtype: Project
@@ -159,7 +160,7 @@ def _get_canonical_project(self, project):
         return project
 
     def _get_project_subdomain(self, project):
-        """Determine canonical project domain as subdomain"""
+        """Determine canonical project domain as subdomain."""
         public_domain = getattr(settings, 'PUBLIC_DOMAIN', None)
         if self._use_subdomain():
             project = self._get_canonical_project(project)
@@ -177,9 +178,10 @@ def _get_private(self, project, version_slug):
 
     def _fix_filename(self, project, filename):
         """
-        Force filenames that might be HTML file paths into proper URL's
+        Force filenames that might be HTML file paths into proper URL's.
 
-        This basically means stripping / and .html endings and then re-adding them properly.
+        This basically means stripping / and .html endings and then re-adding
+        them properly.
         """
         # Bail out on non-html files
         if '.' in filename and '.html' not in filename:
@@ -203,7 +205,7 @@ def _fix_filename(self, project, filename):
         return path
 
     def _use_subdomain(self):
-        """Make decision about whether to use a subdomain to serve docs"""
+        """Make decision about whether to use a subdomain to serve docs."""
         use_subdomain = getattr(settings, 'USE_SUBDOMAIN', False)
         public_domain = getattr(settings, 'PUBLIC_DOMAIN', None)
         return use_subdomain and public_domain is not None