Skip to content

Commit 32d1537

Browse files
committed
Refactor to Themes and Extensions to generalize and include MyST as well as Sphinx.
Add MyST extensions Clean up comments in conf.py
1 parent 70166d0 commit 32d1537

File tree

3 files changed

+23
-10
lines changed

3 files changed

+23
-10
lines changed

docs/conf.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,14 +149,14 @@
149149
# For more information see:
150150
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
151151
myst_enable_extensions = [
152-
"deflist", # You will be able to utilise definition lists
152+
"deflist", # Support definition lists.
153153
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists
154-
"linkify", # Identify bare web URLs and add hyperlinks.
154+
"linkify", # Identify "bare" web URLs and add hyperlinks.
155155
"colon_fence", # You can also use ::: delimiters to denote code fences,\
156156
# instead of ```.
157157
"substitution", # plone.restapi \
158158
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2
159-
"html_image", # For inline images. See https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
159+
"html_image", # For inline images. See https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#html-images
160160
]
161161

162162
myst_substitutions = {

docs/contributing/documentation/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,6 @@ hidden: true
315315
setup-build
316316
authors
317317
myst-reference
318-
sphinx-extensions
318+
themes-and-extensions
319319
admins
320320
```

docs/contributing/documentation/sphinx-extensions.md renamed to docs/contributing/documentation/themes-and-extensions.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
---
22
myst:
33
html_meta:
4-
"description": "Sphinx themes and extensions"
5-
"property=og:description": "Sphinx themes and extensions"
6-
"property=og:title": "Sphinx themes and extensions"
4+
"description": "Themes and extensions"
5+
"property=og:description": "Themes and extensions"
6+
"property=og:title": "Themes and extensions"
77
"keywords": "Documentation, Plone, Sphinx, reStructuredText, MyST, Markdown, themes, sphinx-book-theme, pydata_sphinx_theme, extensions"
88
---
99

10-
(contributing-sphinx-themes-and-extensions)=
10+
(contributing-themes-and-extensions)=
1111

12-
# Sphinx themes and extensions
12+
# Themes and extensions
1313

1414
We learned the hard way that maintaining the design and features of documentation is a lot of work.
1515
To make all documentation maintainable, we use actively developed themes and extensions to build the documentation.
1616

17+
1718
## Themes
1819

1920
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
2526

2627
## Extensions
2728

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.
30+
31+
32+
### MyST
33+
34+
- [`deflist`](https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists) supports definition lists.
35+
- [`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
2942

3043
- [`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.
3144
- [`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

Comments
 (0)