Merge branch 'master' of github.com:rtfd/readthedocs.org into humitos/apiv3-split-tests

Author: humitos

docs/guides/feature-flags.rst

@@ -14,6 +14,12 @@ Available Flags
 
 ``PIP_ALWAYS_UPGRADE``: :featureflags:`PIP_ALWAYS_UPGRADE`
 
+``UPDATE_CONDA_STARTUP``: :featureflags:`UPDATE_CONDA_STARTUP`
+
+The version of ``conda`` used in the build process could not be the latest one.
+This is because we use Miniconda, which its release process is a little more slow than ``conda`` itself.
+In case you prefer to use the latest ``conda`` version available, this is the flag you need.
+
 ``DONT_OVERWRITE_SPHINX_CONTEXT``: :featureflags:`DONT_OVERWRITE_SPHINX_CONTEXT`
 
 ``DONT_SHALLOW_CLONE``: :featureflags:`DONT_SHALLOW_CLONE`
@@ -22,4 +28,4 @@ The ``DONT_SHALLOW_CLONE`` flag is useful if your code accesses old commits duri
 e.g. python-reno release notes manager is known to do that
 (error message line would probably include one of old Git commit id's).
 
-``USE_TESTING_BUILD_IMAGE``: :featureflags:`USE_TESTING_BUILD_IMAGE`
+``USE_TESTING_BUILD_IMAGE``: :featureflags:`USE_TESTING_BUILD_IMAGE`

readthedocs/api/v3/serializers.py

@@ -301,13 +301,26 @@ def get_name(self, programming_language):
         return 'Unknown'
 
 
-class ProjectURLsSerializer(serializers.Serializer):
+class ProjectURLsSerializer(BaseLinksSerializer, serializers.Serializer):
+
+    """Serializer with all the user-facing URLs under Read the Docs."""
+
     documentation = serializers.CharField(source='get_docs_url')
-    project_homepage = serializers.SerializerMethodField()
+    home = serializers.SerializerMethodField()
+    builds = serializers.SerializerMethodField()
+    versions = serializers.SerializerMethodField()
 
-    def get_project_homepage(self, obj):
-        # Overridden only to return ``None`` when the description is ``''``
-        return obj.project_url or None
+    def get_home(self, obj):
+        path = reverse('projects_detail', kwargs={'project_slug': obj.slug})
+        return self._absolute_url(path)
+
+    def get_builds(self, obj):
+        path = reverse('builds_project_list', kwargs={'project_slug': obj.slug})
+        return self._absolute_url(path)
+
+    def get_versions(self, obj):
+        path = reverse('project_version_list', kwargs={'project_slug': obj.slug})
+        return self._absolute_url(path)
 
 
 class RepositorySerializer(serializers.Serializer):
@@ -419,6 +432,7 @@ class Meta:
 
 class ProjectSerializer(FlexFieldsModelSerializer):
 
+    homepage = serializers.SerializerMethodField()
     language = LanguageSerializer()
     programming_language = ProgrammingLanguageSerializer()
     repository = RepositorySerializer(source='*')
@@ -430,8 +444,6 @@ class ProjectSerializer(FlexFieldsModelSerializer):
     tags = serializers.StringRelatedField(many=True)
     users = UserSerializer(many=True)
 
-    description = serializers.SerializerMethodField()
-
     _links = ProjectLinksSerializer(source='*')
 
     # TODO: adapt these fields with the proper names in the db and then remove
@@ -457,11 +469,11 @@ class Meta:
             'id',
             'name',
             'slug',
-            'description',
             'created',
             'modified',
             'language',
             'programming_language',
+            'homepage',
             'repository',
             'default_version',
             'default_branch',
@@ -480,9 +492,9 @@ class Meta:
             '_links',
         ]
 
-    def get_description(self, obj):
-        # Overridden only to return ``None`` when the description is ``''``
-        return obj.description or None
+    def get_homepage(self, obj):
+        # Overridden only to return ``None`` when the project_url is ``''``
+        return obj.project_url or None
 
     def get_translation_of(self, obj):
         if obj.main_language_project:

readthedocs/api/v3/tests/responses/projects-detail.json

@@ -51,7 +51,6 @@
     "created": "2019-04-29T10:00:00Z",
     "default_branch": "master",
     "default_version": "latest",
-    "description": "Project description",
     "id": 1,
     "language": {
         "code": "en",
@@ -77,6 +76,7 @@
         "code": "words",
         "name": "Only Words"
     },
+    "homepage": "http://project.com",
     "repository": {
         "type": "git",
         "url": "https://github.com/rtfd/project"
@@ -90,8 +90,10 @@
     ],
     "translation_of": null,
     "urls": {
+        "builds": "https://readthedocs.org/projects/project/builds/",
         "documentation": "http://readthedocs.org/docs/project/en/latest/",
-        "project_homepage": "http://project.com"
+        "home": "https://readthedocs.org/projects/project/",
+        "versions": "https://readthedocs.org/projects/project/versions/"
     },
     "users": [
         {

readthedocs/api/v3/tests/responses/projects-list.json

@@ -7,7 +7,6 @@
             "id": 1,
             "name": "project",
             "slug": "project",
-            "description": "Project description",
             "created": "2019-04-29T10:00:00Z",
             "modified": "2019-04-29T12:00:00Z",
             "language": {
@@ -18,6 +17,7 @@
                 "code": "words",
                 "name": "Only Words"
             },
+            "homepage": "http://project.com",
             "repository": {
                 "url": "https://github.com/rtfd/project",
                 "type": "git"
@@ -31,8 +31,10 @@
             "subproject_of": null,
             "translation_of": null,
             "urls": {
+                "builds": "https://readthedocs.org/projects/project/builds/",
                 "documentation": "http://readthedocs.org/docs/project/en/latest/",
-                "project_homepage": "http://project.com"
+                "home": "https://readthedocs.org/projects/project/",
+                "versions": "https://readthedocs.org/projects/project/versions/"
             },
             "tags": [
                 "tag",

readthedocs/api/v3/tests/responses/projects-subprojects-list.json

@@ -7,7 +7,6 @@
             "id": 2,
             "name": "subproject",
             "slug": "subproject",
-            "description": "SubProject description",
             "created": "2019-04-29T10:00:00Z",
             "modified": "2019-04-29T12:00:00Z",
             "language": {
@@ -18,6 +17,7 @@
                 "code": "words",
                 "name": "Only Words"
             },
+            "homepage": "http://subproject.com",
             "repository": {
                 "url": "https://github.com/rtfd/subproject",
                 "type": "git"
@@ -32,7 +32,6 @@
                 "id": 1,
                 "name": "project",
                 "slug": "project",
-                "description": "Project description",
                 "created": "2019-04-29T10:00:00Z",
                 "modified": "2019-04-29T12:00:00Z",
                 "language": {
@@ -43,6 +42,7 @@
                     "code": "words",
                     "name": "Only Words"
                 },
+                "homepage": "http://project.com",
                 "repository": {
                     "url": "https://github.com/rtfd/project",
                     "type": "git"
@@ -56,8 +56,10 @@
                 "subproject_of": null,
                 "translation_of": null,
                 "urls": {
+                    "builds": "https://readthedocs.org/projects/project/builds/",
                     "documentation": "http://readthedocs.org/docs/project/en/latest/",
-                    "project_homepage": "http://project.com"
+                    "home": "https://readthedocs.org/projects/project/",
+                    "versions": "https://readthedocs.org/projects/project/versions/"
                 },
                 "tags": [
                     "tag",
@@ -83,8 +85,10 @@
             },
             "translation_of": null,
             "urls": {
+                "builds": "https://readthedocs.org/projects/subproject/builds/",
                 "documentation": "http://readthedocs.org/docs/project/projects/subproject/en/latest/",
-                "project_homepage": "http://subproject.com"
+                "home": "https://readthedocs.org/projects/subproject/",
+                "versions": "https://readthedocs.org/projects/subproject/versions/"
             },
             "tags": [],
             "users": [],

readthedocs/api/v3/tests/responses/projects-superproject.json

@@ -2,7 +2,6 @@
     "created": "2019-04-29T10:00:00Z",
     "default_branch": "master",
     "default_version": "latest",
-    "description": "Project description",
     "id": 1,
     "language": {
         "code": "en",
@@ -28,6 +27,7 @@
         "code": "words",
         "name": "Only Words"
     },
+    "homepage": "http://project.com",
     "repository": {
         "type": "git",
         "url": "https://github.com/rtfd/project"
@@ -41,8 +41,10 @@
     ],
     "translation_of": null,
     "urls": {
+        "builds": "https://readthedocs.org/projects/project/builds/",
         "documentation": "http://readthedocs.org/docs/project/en/latest/",
-        "project_homepage": "http://project.com"
+        "home": "https://readthedocs.org/projects/project/",
+        "versions": "https://readthedocs.org/projects/project/versions/"
     },
     "users": [
         {

readthedocs/api/v3/tests/responses/projects-versions-builds-list_POST.json

@@ -23,7 +23,6 @@
         "created": "2019-04-29T10:00:00Z",
         "default_branch": "master",
         "default_version": "latest",
-        "description": "Project description",
         "id": 1,
         "language": {
             "code": "en",
@@ -49,6 +48,7 @@
             "code": "words",
             "name": "Only Words"
         },
+        "homepage": "http://project.com",
         "repository": {
             "type": "git",
             "url": "https://github.com/rtfd/project"
@@ -62,8 +62,10 @@
         ],
         "translation_of": null,
         "urls": {
+            "builds": "https://readthedocs.org/projects/project/builds/",
             "documentation": "http://readthedocs.org/docs/project/en/latest/",
-            "project_homepage": "http://project.com"
+            "home": "https://readthedocs.org/projects/project/",
+            "versions": "https://readthedocs.org/projects/project/versions/"
         },
         "users": [
             {

readthedocs/builds/admin.py

@@ -1,11 +1,17 @@
 """Django admin interface for `~builds.models.Build` and related models."""
 
+import json
 from django.contrib import admin, messages
+from django.utils.safestring import mark_safe
 from polymorphic.admin import (
     PolymorphicChildModelAdmin,
     PolymorphicParentModelAdmin,
 )
 
+from pygments import highlight
+from pygments.lexers import JsonLexer
+from pygments.formatters import HtmlFormatter
+
 from readthedocs.builds.models import (
     Build,
     BuildCommandResult,
@@ -19,6 +25,29 @@
 from readthedocs.search.utils import _indexing_helper
 
 
+def _pretty_config(instance):
+    """
+    Function to display pretty version of our data.
+
+    Thanks to PyDanny: https://www.pydanny.com/pretty-formatting-json-django-admin.html
+    """
+
+    # Convert the data to sorted, indented JSON
+    response = json.dumps(instance.config, sort_keys=True, indent=2)
+
+    # Get the Pygments formatter
+    formatter = HtmlFormatter()
+
+    # Highlight the data
+    response = highlight(response, JsonLexer(), formatter)
+
+    # Get the stylesheet
+    style = "<style>" + formatter.get_style_defs() + "</style><br>"
+
+    # Safe the output
+    return mark_safe(style + response)
+
+
 class BuildCommandResultInline(admin.TabularInline):
     model = BuildCommandResult
     fields = ('command', 'exit_code', 'output')
@@ -34,6 +63,10 @@ class BuildAdmin(admin.ModelAdmin):
         'success',
         'length',
         'cold_storage',
+        'pretty_config',
+    )
+    readonly_fields = (
+        'pretty_config',  # required to be read-only becuase it's a @property
     )
     list_display = (
         'id',
@@ -54,6 +87,11 @@ class BuildAdmin(admin.ModelAdmin):
     def version_name(self, obj):
         return obj.version.verbose_name
 
+    def pretty_config(self, instance):
+        return _pretty_config(instance)
+
+    pretty_config.short_description = 'Config File'
+
 
 class VersionAdmin(admin.ModelAdmin):
 
@@ -65,6 +103,9 @@ class VersionAdmin(admin.ModelAdmin):
         'active',
         'built',
     )
+    readonly_fields = (
+        'pretty_config',  # required to be read-only becuase it's a @property
+    )
     list_filter = ('type', 'privacy_level', 'active', 'built')
     search_fields = ('slug', 'project__slug')
     raw_id_fields = ('project',)
@@ -83,6 +124,10 @@ def wipe_selected_versions(self, request, queryset):
                 level=messages.SUCCESS
             )
 
+    def pretty_config(self, instance):
+        return _pretty_config(instance)
+
+    pretty_config.short_description = 'Config File'
     wipe_selected_versions.short_description = 'Wipe selected versions'
 
     def build_version(self, request, queryset):