Merge branch 'master' of github.com:readthedocs/readthedocs.org into cache-robotstxt

Author: ericholscher

readthedocs/builds/constants.py

@@ -100,8 +100,6 @@
     },
 }
 
-RTD_BUILD_STATUS_API_NAME = 'continuous-documentation/read-the-docs'
-
 GITHUB_EXTERNAL_VERSION_NAME = 'Pull Request'
 GITLAB_EXTERNAL_VERSION_NAME = 'Merge Request'
 GENERIC_EXTERNAL_VERSION_NAME = 'External Version'

readthedocs/builds/migrations/0016_add_mkdocs_html_doctype.py

@@ -0,0 +1,18 @@
+# Generated by Django 2.2.11 on 2020-04-01 20:07
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('builds', '0015_uploading_build_state'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='version',
+            name='documentation_type',
+            field=models.CharField(choices=[('sphinx', 'Sphinx Html'), ('mkdocs', 'Mkdocs (Markdown)'), ('sphinx_htmldir', 'Sphinx HtmlDir'), ('sphinx_singlehtml', 'Sphinx Single Page HTML'), ('mkdocs_html', 'Mkdocs Html Pages')], default='sphinx', help_text='Type of documentation the version was built with.', max_length=20, verbose_name='Documentation type'),
+        ),
+    ]

readthedocs/builds/models.py

@@ -64,19 +64,20 @@
 from readthedocs.projects.constants import (
     BITBUCKET_COMMIT_URL,
     BITBUCKET_URL,
+    DOCTYPE_CHOICES,
     GITHUB_BRAND,
     GITHUB_COMMIT_URL,
     GITHUB_PULL_REQUEST_COMMIT_URL,
     GITHUB_PULL_REQUEST_URL,
     GITHUB_URL,
     GITLAB_BRAND,
     GITLAB_COMMIT_URL,
-    DOCUMENTATION_CHOICES,
     GITLAB_MERGE_REQUEST_COMMIT_URL,
     GITLAB_MERGE_REQUEST_URL,
     GITLAB_URL,
     MEDIA_TYPES,
     PRIVACY_CHOICES,
+    SPHINX,
 )
 from readthedocs.projects.models import APIProject, Project
 from readthedocs.projects.version_handling import determine_stable_version
@@ -145,8 +146,8 @@ class Version(models.Model):
     documentation_type = models.CharField(
         _('Documentation type'),
         max_length=20,
-        choices=DOCUMENTATION_CHOICES,
-        default='sphinx',
+        choices=DOCTYPE_CHOICES,
+        default=SPHINX,
         help_text=_(
             'Type of documentation the version was built with.'
         ),

readthedocs/doc_builder/backends/mkdocs.py

@@ -11,6 +11,7 @@
 import yaml
 from django.conf import settings
 from django.template import loader as template_loader
+from readthedocs.projects.constants import MKDOCS_HTML, MKDOCS
 
 from readthedocs.doc_builder.base import BaseBuilder
 from readthedocs.doc_builder.exceptions import MkDocsYAMLParseError
@@ -67,6 +68,17 @@ def __init__(self, *args, **kwargs):
         else:
             self.DEFAULT_THEME_NAME = 'mkdocs'
 
+    def get_final_doctype(self):
+        """
+        Select a doctype based on the ``use_directory_urls`` setting.
+
+        https://www.mkdocs.org/user-guide/configuration/#use_directory_urls
+        """
+        with open(self.yaml_file, 'r') as f:
+            config = yaml.safe_load(f)
+            use_directory_urls = config.get('use_directory_urls', True)
+            return MKDOCS if use_directory_urls else MKDOCS_HTML
+
     def get_yaml_config(self):
         """Find the ``mkdocs.yml`` file in the project root."""
         mkdocs_path = self.config.mkdocs.configuration

readthedocs/doc_builder/base.py

@@ -51,6 +51,10 @@ def __init__(self, build_env, python_env, force=False):
             type_=self.type,
         )
 
+    def get_final_doctype(self):
+        """Some builders may have a different doctype at build time."""
+        return self.config.doctype
+
     def force(self, **__):
         """An optional step to force a build even when nothing has changed."""
         log.info('Forcing a build')

readthedocs/oauth/services/github.py

@@ -15,7 +15,6 @@
 from readthedocs.builds.constants import (
     BUILD_STATUS_SUCCESS,
     SELECT_BUILD_STATUS,
-    RTD_BUILD_STATUS_API_NAME
 )
 from readthedocs.integrations.models import Integration
 
@@ -438,7 +437,7 @@ def send_build_status(self, build, commit, state):
             'state': github_build_state,
             'target_url': target_url,
             'description': description,
-            'context': RTD_BUILD_STATUS_API_NAME
+            'context': settings.RTD_BUILD_STATUS_API_NAME
         }
 
         resp = None

readthedocs/oauth/services/gitlab.py

@@ -11,7 +11,6 @@
 
 from readthedocs.builds.constants import (
     BUILD_STATUS_SUCCESS,
-    RTD_BUILD_STATUS_API_NAME,
     SELECT_BUILD_STATUS,
 )
 from readthedocs.builds import utils as build_utils
@@ -524,7 +523,7 @@ def send_build_status(self, build, commit, state):
             'state': gitlab_build_state,
             'target_url': target_url,
             'description': description,
-            'context': RTD_BUILD_STATUS_API_NAME
+            'context': settings.RTD_BUILD_STATUS_API_NAME
         }
         url = self.adapter.provider_base_url
 

readthedocs/projects/constants.py

@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 """
 Project constants.
 
@@ -11,13 +9,20 @@
 
 from django.utils.translation import ugettext_lazy as _
 
-
+SPHINX = 'sphinx'
+MKDOCS = 'mkdocs'
+SPHINX_HTMLDIR = 'sphinx_htmldir'
+SPHINX_SINGLEHTML = 'sphinx_singlehtml'
+# This type is defined by the users in their mkdocs.yml file.
+MKDOCS_HTML = 'mkdocs_html'
 DOCUMENTATION_CHOICES = (
-    ('sphinx', _('Sphinx Html')),
-    ('mkdocs', _('Mkdocs (Markdown)')),
-    ('sphinx_htmldir', _('Sphinx HtmlDir')),
-    ('sphinx_singlehtml', _('Sphinx Single Page HTML')),
+    (SPHINX, _('Sphinx Html')),
+    (MKDOCS, _('Mkdocs (Markdown)')),
+    (SPHINX_HTMLDIR, _('Sphinx HtmlDir')),
+    (SPHINX_SINGLEHTML, _('Sphinx Single Page HTML')),
 )
+DOCTYPE_CHOICES = DOCUMENTATION_CHOICES + ((MKDOCS_HTML, _('Mkdocs Html Pages')),)
+
 
 MEDIA_TYPE_HTML = 'html'
 MEDIA_TYPE_PDF = 'pdf'

readthedocs/projects/tasks.py

@@ -34,12 +34,12 @@
     BUILD_STATE_FINISHED,
     BUILD_STATE_INSTALLING,
     BUILD_STATE_UPLOADING,
-    BUILD_STATUS_SUCCESS,
     BUILD_STATUS_FAILURE,
+    BUILD_STATUS_SUCCESS,
+    EXTERNAL,
     LATEST,
     LATEST_VERBOSE_NAME,
     STABLE_VERBOSE_NAME,
-    EXTERNAL,
 )
 from readthedocs.builds.models import APIVersion, Build, Version
 from readthedocs.builds.signals import build_complete
@@ -68,7 +68,7 @@
 from readthedocs.doc_builder.python_environments import Conda, Virtualenv
 from readthedocs.oauth.models import RemoteRepository
 from readthedocs.oauth.notifications import GitBuildStatusFailureNotification
-from readthedocs.projects.constants import GITHUB_BRAND, GITLAB_BRAND
+from readthedocs.projects.constants import GITHUB_BRAND, GITLAB_BRAND, MKDOCS
 from readthedocs.projects.models import APIProject, Feature
 from readthedocs.search.utils import index_new_files, remove_indexed_files
 from readthedocs.sphinx_domains.models import SphinxDomain
@@ -940,7 +940,7 @@ def store_build_artifacts(
                 version = api_v2.version(self.version.pk)
                 version.patch({
                     'built': True,
-                    'documentation_type': self.config.doctype,
+                    'documentation_type': self.get_final_doctype(),
                     'has_pdf': pdf,
                     'has_epub': epub,
                     'has_htmlzip': localmedia,
@@ -1085,7 +1085,7 @@ def update_app_instances(
                 version = api_v2.version(self.version.pk)
                 version.patch({
                     'built': True,
-                    'documentation_type': self.config.doctype,
+                    'documentation_type': self.get_final_doctype(),
                     'has_pdf': pdf,
                     'has_epub': epub,
                     'has_htmlzip': localmedia,
@@ -1206,6 +1206,13 @@ def build_docs_html(self):
 
         return success
 
+    def get_final_doctype(self):
+        html_builder = get_builder_class(self.config.doctype)(
+            build_env=self.build_env,
+            python_env=self.python_env,
+        )
+        return html_builder.get_final_doctype()
+
     def build_docs_search(self):
         """Build search data."""
         # Search is always run in sphinx using the rtd-sphinx-extension.

readthedocs/projects/views/mixins.py

@@ -1,10 +1,10 @@
-# -*- coding: utf-8 -*-
-
 """Mixin classes for project views."""
+from urllib.parse import urlparse
 
 from celery import chain
 from django.shortcuts import get_object_or_404
 
+from readthedocs.core.resolver import resolve, resolve_path
 from readthedocs.core.utils import prepare_build
 from readthedocs.projects.models import Project
 from readthedocs.projects.signals import project_import
@@ -49,6 +49,44 @@ def get_context_data(self, **kwargs):
         return context
 
 
+class ProjectRelationListMixin:
+
+    """Injects ``subprojects_and_urls`` into the context."""
+
+    def get_context_data(self, **kwargs):
+        context = super().get_context_data(**kwargs)
+        context['subprojects_and_urls'] = self._get_subprojects_and_urls()
+        return context
+
+    def _get_subprojects_and_urls(self):
+        """
+        Get a tuple of subprojects and its absolute URls.
+
+        All subprojects share the domain from the parent,
+        so instead of resolving the domain and path for each subproject,
+        we resolve only the path of each one.
+        """
+        subprojects_and_urls = []
+
+        project = self.get_project()
+        main_domain = resolve(project)
+        parsed_main_domain = urlparse(main_domain)
+
+        subprojects = project.subprojects.select_related('child')
+        for subproject in subprojects:
+            subproject_path = resolve_path(subproject.child)
+            parsed_subproject_domain = parsed_main_domain._replace(
+                path=subproject_path,
+            )
+            subprojects_and_urls.append(
+                (
+                    subproject,
+                    parsed_subproject_domain.geturl(),
+                )
+            )
+        return subprojects_and_urls
+
+
 class ProjectImportMixin:
 
     """Helpers to import a Project."""

readthedocs/projects/views/private.py

@@ -2,7 +2,6 @@
 
 import csv
 import logging
-from urllib.parse import urlparse
 
 from allauth.socialaccount.models import SocialAccount
 from django.conf import settings
@@ -45,7 +44,6 @@
     LoginRequiredMixin,
     PrivateViewMixin,
 )
-from readthedocs.core.resolver import resolve, resolve_path
 from readthedocs.core.utils import broadcast, trigger_build
 from readthedocs.core.utils.extend import SettingsOverrideObject
 from readthedocs.integrations.models import HttpExchange, Integration
@@ -81,7 +79,10 @@
 from readthedocs.projects.notifications import EmailConfirmNotification
 from readthedocs.projects.utils import Echo
 from readthedocs.projects.views.base import ProjectAdminMixin, ProjectSpamMixin
-from readthedocs.projects.views.mixins import ProjectImportMixin
+from readthedocs.projects.views.mixins import (
+    ProjectImportMixin,
+    ProjectRelationListMixin,
+)
 from readthedocs.search.models import SearchQuery
 
 from ..tasks import retry_domain_verification
@@ -459,41 +460,13 @@ def get_success_url(self):
         return reverse('projects_subprojects', args=[self.get_project().slug])
 
 
-class ProjectRelationshipList(ProjectRelationshipMixin, ListView):
+class ProjectRelationshipList(ProjectRelationListMixin, ProjectRelationshipMixin, ListView):
 
     def get_context_data(self, **kwargs):
         ctx = super().get_context_data(**kwargs)
         ctx['superproject'] = self.project.superprojects.first()
-        ctx['subprojects_and_urls'] = self.get_subprojects_and_urls()
         return ctx
 
-    def get_subprojects_and_urls(self):
-        """
-        Get a tuple of subprojects and its absolute URls.
-
-        All subprojects share the domain from the parent,
-        so instead of resolving the domain and path for each subproject,
-        we resolve only the path of each one.
-        """
-        subprojects_and_urls = []
-
-        main_domain = resolve(self.project)
-        parsed_main_domain = urlparse(main_domain)
-
-        subprojects = self.object_list.select_related('child')
-        for subproject in subprojects:
-            subproject_path = resolve_path(subproject.child)
-            parsed_subproject_domain = parsed_main_domain._replace(
-                path=subproject_path,
-            )
-            subprojects_and_urls.append(
-                (
-                    subproject,
-                    parsed_subproject_domain.geturl(),
-                )
-            )
-        return subprojects_and_urls
-
 
 class ProjectRelationshipCreate(ProjectRelationshipMixin, CreateView):