Merge branch 'master' into separate-dev-docs

Author: stsewd

CHANGELOG.rst

@@ -1,3 +1,32 @@
+Version 6.3.1
+-------------
+
+:Date: December 14, 2021
+
+* `@stsewd <https://github.com/stsewd>`__: Explicit settings for some tests (`#8759 <https://github.com/readthedocs/readthedocs.org/pull/8759>`__)
+* `@stsewd <https://github.com/stsewd>`__: Don't run spam rules check after ban action (`#8756 <https://github.com/readthedocs/readthedocs.org/pull/8756>`__)
+* `@astrojuanlu <https://github.com/astrojuanlu>`__: Add MyST Markdown examples everywhere (`#8752 <https://github.com/readthedocs/readthedocs.org/pull/8752>`__)
+* `@astrojuanlu <https://github.com/astrojuanlu>`__: Update mambaforge to latest version (`#8749 <https://github.com/readthedocs/readthedocs.org/pull/8749>`__)
+* `@stsewd <https://github.com/stsewd>`__: Update django (`#8748 <https://github.com/readthedocs/readthedocs.org/pull/8748>`__)
+* `@astrojuanlu <https://github.com/astrojuanlu>`__: Remove sphinx-doc.org from external domains (`#8747 <https://github.com/readthedocs/readthedocs.org/pull/8747>`__)
+* `@stsewd <https://github.com/stsewd>`__: Fix call to sync_remote_repositories (`#8742 <https://github.com/readthedocs/readthedocs.org/pull/8742>`__)
+* `@stsewd <https://github.com/stsewd>`__: Tests: set privacy level explicitly (`#8740 <https://github.com/readthedocs/readthedocs.org/pull/8740>`__)
+* `@humitos <https://github.com/humitos>`__: Spam: contact link on template (`#8739 <https://github.com/readthedocs/readthedocs.org/pull/8739>`__)
+* `@humitos <https://github.com/humitos>`__: Spam: fix admin filter (`#8738 <https://github.com/readthedocs/readthedocs.org/pull/8738>`__)
+* `@stsewd <https://github.com/stsewd>`__: Always clear cache after each test (`#8737 <https://github.com/readthedocs/readthedocs.org/pull/8737>`__)
+* `@humitos <https://github.com/humitos>`__: Logging: tweaks and minor improvements (`#8736 <https://github.com/readthedocs/readthedocs.org/pull/8736>`__)
+* `@humitos <https://github.com/humitos>`__: Logs: typo on keyname (`#8734 <https://github.com/readthedocs/readthedocs.org/pull/8734>`__)
+* `@humitos <https://github.com/humitos>`__: Log: use structlog-sentry to send logs to Sentry (`#8732 <https://github.com/readthedocs/readthedocs.org/pull/8732>`__)
+* `@humitos <https://github.com/humitos>`__: docs: use Python 3.8 to build our docs (`#8731 <https://github.com/readthedocs/readthedocs.org/pull/8731>`__)
+* `@agjohnson <https://github.com/agjohnson>`__: Release 6.3.0 (`#8730 <https://github.com/readthedocs/readthedocs.org/pull/8730>`__)
+* `@stsewd <https://github.com/stsewd>`__: Custom Domain: make cname_target configurable (`#8728 <https://github.com/readthedocs/readthedocs.org/pull/8728>`__)
+* `@stsewd <https://github.com/stsewd>`__: Test external serving for projects with `--` in slug (`#8716 <https://github.com/readthedocs/readthedocs.org/pull/8716>`__)
+* `@astrojuanlu <https://github.com/astrojuanlu>`__: Add guide to migrate from reST to MyST (`#8714 <https://github.com/readthedocs/readthedocs.org/pull/8714>`__)
+* `@astrojuanlu <https://github.com/astrojuanlu>`__: Avoid future breakage of `setup.py` invokations (`#8711 <https://github.com/readthedocs/readthedocs.org/pull/8711>`__)
+* `@humitos <https://github.com/humitos>`__: structlog: migrate application code to better logging (`#8705 <https://github.com/readthedocs/readthedocs.org/pull/8705>`__)
+* `@humitos <https://github.com/humitos>`__: EmbedAPI: log success requests (`#8689 <https://github.com/readthedocs/readthedocs.org/pull/8689>`__)
+* `@ericholscher <https://github.com/ericholscher>`__: Add ability to rebuild a specific build (`#6995 <https://github.com/readthedocs/readthedocs.org/pull/6995>`__)
+
 Version 6.3.0
 -------------
 

common

@@ -1,5 +1,5 @@
-Ethical Ads
-===========
+EthicalAds
+==========
 
 .. meta::
    :description lang=en: To fund Read the Docs, we built an ad platform that doesn't track users and respects their privacy.
@@ -8,9 +8,9 @@ Ethical Ads
 Read the Docs is a large, free web service.
 There is one proven business model to support this kind of site: **Advertising**.
 We are building the advertising model we want to exist,
-and we're calling it **Ethical Ads**.
+and we're calling it **EthicalAds**.
 
-**Ethical Ads respect users while providing value to advertisers.**
+**EthicalAds respect users while providing value to advertisers.**
 We don't track you, sell your data, or anything else.
 We simply show ads to users, based on the content of the pages you look at.
 We also give 10% of our ad space to :ref:`community projects <advertising/ethical-advertising:Community Ads>`,

docs/user/advertising/ethical-advertising.rst

@@ -79,17 +79,33 @@ and show a modal when the user clicks in a "Help" link.
     To avoid that, you can manually define Sphinx references above the sections you don't want to break.
     For example,
 
-    .. code-block:: rst
-       :emphasize-lines: 3
+    .. tabs::
 
-       .. in your .rst document file
+       .. tab:: reStructuredText
 
-       .. _unbreakable-section-reference:
+          .. code-block:: rst
+             :emphasize-lines: 3
 
-       Creating an automation rule
-       ---------------------------
+             .. in your .rst document file
 
-       This is the text of the section.
+             .. _unbreakable-section-reference:
+
+             Creating an automation rule
+             ---------------------------
+
+             This is the text of the section.
+
+       .. tab:: MyST (Markdown)
+
+          .. code-block:: md
+             :emphasize-lines: 3
+
+             .. in your .md document file
+
+             (unbreakable-section-reference)=
+             ## Creating an automation rule
+
+             This is the text of the section.
 
     To link to the section "Creating an automation rule" you can send ``section=unbreakable-section-reference``.
     If you change the title it won't break the embedded content because the label for that title will still be ``unbreakable-section-reference``.

docs/user/guides/embedding-content.rst

@@ -58,13 +58,29 @@ Next, you will need to enable one of the extensions, as follows:
 Finally, you can include the notebook in any *toctree*.
 For example, add this to your root document:
 
-.. code-block:: rest
+.. tabs::
+
+   .. tab:: reStructuredText
+
+      .. code-block:: rst
+
+         .. toctree::
+            :maxdepth: 2
+            :caption: Contents:
 
-   .. toctree::
-      :maxdepth: 2
-      :caption: Contents:
+            notebooks/Example 1
 
-      notebooks/Example 1
+   .. tab:: MyST (Markdown)
+
+      .. code-block:: md
+
+         ```{toctree}
+         ---
+         maxdepth: 2
+         caption: Contents:
+         ---
+         notebooks/Example 1
+         ```
 
 The notebook will render as any other HTML page in your documentation
 after doing ``make html``.
@@ -255,14 +271,29 @@ For example, this reST markup would create a thumbnail gallery
 with generic images as thumbnails,
 thanks to the Sphinx-Gallery default style:
 
-.. code-block:: rest
+.. tabs::
+
+   .. tab:: reStructuredText
+
+      .. code-block:: rst
+
+         Thumbnails gallery
+         ==================
+
+         .. nbgallery::
+            notebooks/Example 1
+            notebooks/Example 2
+
+   .. tab:: MyST (Markdown)
+
+      .. code-block:: md
 
-   Thumbnails gallery
-   ==================
+         # Thumbnails gallery
 
-   .. nbgallery::
-      notebooks/Example 1
-      notebooks/Example 2
+         ```{nbgallery}
+         notebooks/Example 1
+         notebooks/Example 2
+         ```
 
 .. figure:: /_static/images/guides/thumbnail-gallery.png
    :width: 80%

docs/user/guides/jupyter.rst

@@ -68,6 +68,12 @@ class WebhookMixin:
     def post(self, request, project_slug):
         """Set up webhook post view with request and project objects."""
         self.request = request
+
+        log.bind(
+            project_slug=project_slug,
+            integration_type=self.integration_type,
+        )
+
         # WARNING: this is a hack to allow us access to `request.body` later.
         # Due to a limitation of DRF, we can't access `request.body`
         # after accessing `request.data`.
@@ -85,11 +91,7 @@ def post(self, request, project_slug):
         except Project.DoesNotExist:
             raise NotFound('Project not found')
         if not self.is_payload_valid():
-            log.warning(
-                'Invalid payload for project and integration.',
-                project_slug=project_slug,
-                integration_type=self.integration_type,
-            )
+            log.warning('Invalid payload for project and integration.')
             return Response(
                 {'detail': self.invalid_payload_msg},
                 status=HTTP_400_BAD_REQUEST,
@@ -186,7 +188,6 @@ def get_response_push(self, project, branches):
         if not_building:
             log.info(
                 'Skipping project branches.',
-                project_slug=project.slug,
                 branches=branches,
             )
         triggered = bool(to_build)
@@ -338,10 +339,7 @@ def is_payload_valid(self):
         signature = self.request.META.get(GITHUB_SIGNATURE_HEADER)
         secret = self.get_integration().secret
         if not secret:
-            log.info(
-                'Skipping payload signature validation.',
-                project_slug=self.project.slug,
-            )
+            log.debug('Skipping payload signature validation.')
             return True
         if not signature:
             return False
@@ -397,6 +395,7 @@ def handle_webhook(self):
         created = self.data.get('created', False)
         deleted = self.data.get('deleted', False)
         event = self.request.META.get(GITHUB_EVENT_HEADER, GITHUB_PUSH)
+        log.bind(webhook_event=event)
         webhook_github.send(
             Project,
             project=self.project,
@@ -406,11 +405,7 @@ def handle_webhook(self):
 
         # Sync versions when a branch/tag was created/deleted
         if event in (GITHUB_CREATE, GITHUB_DELETE):
-            log.info(
-                'Triggered sync_versions.',
-                project_slug=self.project.slug,
-                webhook_event=event,
-            )
+            log.info('Triggered sync_versions.')
             return self.sync_versions_response(self.project)
 
         # Handle pull request events
@@ -446,7 +441,10 @@ def handle_webhook(self):
                 # already have the CREATE/DELETE events. So we don't trigger the sync twice.
                 return self.sync_versions_response(self.project, sync=False)
 
-            log.info('Triggered sync_versions.', project_slug=self.project.slug, events=events)
+            log.info(
+                'Triggered sync_versions.',
+                integration_events=events,
+            )
             return self.sync_versions_response(self.project)
 
         # Trigger a build for all branches in the push
@@ -516,10 +514,7 @@ def is_payload_valid(self):
         token = self.request.META.get(GITLAB_TOKEN_HEADER)
         secret = self.get_integration().secret
         if not secret:
-            log.info(
-                'Skipping payload signature validation.',
-                project_slug=self.project.slug,
-            )
+            log.debug('Skipping payload signature validation.')
             return True
         if not token:
             return False
@@ -546,6 +541,7 @@ def handle_webhook(self):
         """
         event = self.request.data.get('object_kind', GITLAB_PUSH)
         action = self.data.get('object_attributes', {}).get('action', None)
+        log.bind(webhook_event=event)
         webhook_gitlab.send(
             Project,
             project=self.project,
@@ -561,7 +557,6 @@ def handle_webhook(self):
             if GITLAB_NULL_HASH in (before, after):
                 log.info(
                     'Triggered sync_versions.',
-                    project_slug=self.project.slug,
                     before=before,
                     after=after,
                 )
@@ -638,6 +633,7 @@ def handle_webhook(self):
         attribute (null if it is a creation).
         """
         event = self.request.META.get(BITBUCKET_EVENT_HEADER, BITBUCKET_PUSH)
+        log.bind(webhook_event=event)
         webhook_bitbucket.send(
             Project,
             project=self.project,
@@ -661,11 +657,7 @@ def handle_webhook(self):
                 # will be triggered with the normal push.
                 if branches:
                     return self.get_response_push(self.project, branches)
-                log.info(
-                    'Triggered sync_versions.',
-                    project_slug=self.project.slug,
-                    webhook_event=event,
-                )
+                log.info('Triggered sync_versions.')
                 return self.sync_versions_response(self.project)
             except KeyError:
                 raise ParseError('Invalid request')

readthedocs/api/v2/views/integrations.py

@@ -546,8 +546,12 @@ def __exit__(self, exc_type, exc_value, tb):
         self.update_build(BUILD_STATE_FINISHED)
         log.info(
             'Build finished',
+            # TODO: move all of these attributes to ``log.bind`` if possible
             project_slug=self.project.slug if self.project else '',
             version_slug=self.version.slug if self.version else '',
+            # TODO: add organization_slug here
+            success=self.build.get('success') if self.build else '',
+            length=self.build.get('length') if self.build else '',
         )
         return ret
 

readthedocs/doc_builder/environments.py

@@ -346,6 +346,8 @@ def get(self, request):  # noqa
             'EmbedAPI successful response.',
             project_slug=self.unresolved_url.project.slug if not external else None,
             domain=domain if external else None,
+            doctool=doctool,
+            doctoolversion=doctoolversion,
             url=url,
             referer=request.META.get('HTTP_REFERER'),
             external=external,