Skip to content

Commit a9554f6

Browse files
committed
Add section for Sphinx themes
1 parent e5e9254 commit a9554f6

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

docs/contributing/documentation/sphinx-extensions.md

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

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

12-
# Sphinx extensions
12+
# Sphinx themes and extensions
13+
14+
We learned the hard way that maintaining the design and features of documentation is a lot of work.
15+
To make all documentation maintainable, we use actively developed themes and extensions to build the documentation.
16+
17+
## Themes
18+
19+
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).
20+
See their documentation for features, tips, and tricks that you might want to include in your documentation.
21+
22+
We minimize the customizations of these themes as much as possible.
23+
The one large customization is the search filter by part of the documentation, implemented in modifcations to the templates, {file}`_static/searchtools.js`, and the CSS file {file}`_static/custom.css`.
24+
25+
26+
## Extensions
1327

1428
We use several Sphinx extensions to enhance the presentation of Plone documentation.
1529

0 commit comments

Comments
 (0)