From dde5b5b3d27eae6a25a04688adee1dc90e5115cc Mon Sep 17 00:00:00 2001 From: Sage Abdullah Date: Wed, 30 Oct 2024 13:21:34 +0000 Subject: [PATCH] Fix remaining XHTML errors in docs to remove ePub build errors Had to remove the
element for the section linking example in the "Reference links" section. This is because Sphinx/MyST renders a
element for each heading and closes it when the next heading starts. If we create a heading inside a
element, the
element will not be closed until the next heading starts, which generates invalid HTML. --- docs/advanced_topics/icons.md | 2 +- docs/contributing/documentation_guidelines.md | 6 +----- docs/topics/images.md | 6 +++--- 3 files changed, 5 insertions(+), 9 deletions(-) diff --git a/docs/advanced_topics/icons.md b/docs/advanced_topics/icons.md index 26af40ae22..811de4e052 100644 --- a/docs/advanced_topics/icons.md +++ b/docs/advanced_topics/icons.md @@ -84,7 +84,7 @@ Enable the [styleguide](styleguide) to view the available icons and their names Here are all available icons out of the box: -
+
Toggle icons table diff --git a/docs/contributing/documentation_guidelines.md b/docs/contributing/documentation_guidelines.md index 0f2bcbe3ca..b792382315 100644 --- a/docs/contributing/documentation_guidelines.md +++ b/docs/contributing/documentation_guidelines.md @@ -200,9 +200,7 @@ The reference can be linked to, with an optional label, using the Markdown link - [label for section](my_awesome_section) ``` -
- -Rendered output +Rendered output: (my_awesome_section)= @@ -213,8 +211,6 @@ The reference can be linked to, with an optional label, using the Markdown link - Auto generated label (preferred) [](my_awesome_section) - [label for section](my_awesome_section) -
- You can read more about other methods of linking to, and creating references in the MyST parser docs section on [Targets and cross-referencing](https://myst-parser.readthedocs.io/en/stable/syntax/cross-referencing.html). #### Intersphinx links (external docs) diff --git a/docs/topics/images.md b/docs/topics/images.md index b8f96b05e5..d9217c1666 100644 --- a/docs/topics/images.md +++ b/docs/topics/images.md @@ -394,15 +394,15 @@ Wagtail comes with three pre-defined image formats, but more can be defined in P ### `Full width` -Creates an image rendition using `width-800`, giving the tag the CSS class `full-width`. +Creates an image rendition using `width-800`, giving the `` tag the CSS class `full-width`. ### `Left-aligned` -Creates an image rendition using `width-500`, giving the tag the CSS class `left`. +Creates an image rendition using `width-500`, giving the `` tag the CSS class `left`. ### `Right-aligned` -Creates an image rendition using `width-500`, giving the tag the CSS class `right`. +Creates an image rendition using `width-500`, giving the `` tag the CSS class `right`. ```{note} The CSS classes added to images do **not** come with any accompanying stylesheets or inline styles. For example, the `left` class will do nothing, by default. The developer is expected to add these classes to their front-end CSS files, to define exactly what they want `left`, `right` or `full-width` to mean.