Merge branch 'master' into improve-detail-view

Author: stsewd

readthedocs/api/v2/views/model_views.py

@@ -14,6 +14,7 @@
     BRANCH,
     TAG,
     INTERNAL,
+    BUILD_STATE_TRIGGERED,
     BUILD_STATE_FINISHED,
 )
 from readthedocs.builds.models import Build, BuildCommandResult, Version
@@ -291,7 +292,7 @@ def running(self, request, **kwargs):
         queryset = (
             self.get_queryset()
             .filter(project__slug=project_slug)
-            .exclude(state__in=[BUILD_STATE_FINISHED])
+            .exclude(state__in=[BUILD_STATE_TRIGGERED, BUILD_STATE_FINISHED])
         )
         return Response({'count': queryset.count()})
 

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/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.
@@ -1611,7 +1618,7 @@ def warn(self, msg):
 
     invdata = intersphinx.fetch_inventory(MockApp(), '', object_file_url)
     for key, value in sorted(invdata.items() or {}):
-        domain, _type = key.split(':')
+        domain, _type = key.split(':', 1)
         for name, einfo in sorted(value.items()):
             # project, version, url, display_name
             # ('Sphinx', '1.7.9', 'faq.html#epub-faq', 'Epub info')