You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We learned the hard way that maintaining the design and features of documentation is a lot of work.
15
15
To make all documentation maintainable, we use actively developed themes and extensions to build the documentation.
16
16
17
+
17
18
## Themes
18
19
19
20
When customizing the theme, we use [Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/en/stable/), which in turn depends on [PyData Sphinx Theme](https://pydata-sphinx-theme.readthedocs.io/en/stable/index.html).
@@ -25,7 +26,19 @@ The one large customization is the search filter by part of the documentation, i
25
26
26
27
## Extensions
27
28
28
-
We use several Sphinx extensions to enhance the presentation of Plone documentation.
29
+
We use several MyST and Sphinx extensions to enhance the presentation of Plone documentation.
-[`linkify`](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#linkify) identifies "bare" web URLs and adds hyperlinks.
36
+
-[`colon_fence`](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#code-fences-using-colons) supports the use of three colons `:::` as delimiters to denote code fences, instead of three backticks `` ``` ``.
37
+
-[`substitution`](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2) supports the use of substitutions with Jinja2.
38
+
-[`html_image`](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#html-images) supports the use of HTML `<img>` tags.
39
+
40
+
41
+
### Sphinx
29
42
30
43
-[`sphinx.ext.graphviz`](https://www.sphinx-doc.org/en/master/usage/extensions/graphviz.html) allows you to embed [Graphviz](https://graphviz.org/download/) graphs in your documents.
31
44
-[`sphinx.ext.intersphinx`](https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html) provides linking between separate projects that use Sphinx for documentation.
0 commit comments