Skip to content

Commit

Permalink
Merge pull request #1490 from plone/add-sphinx-themes-mention
Browse files Browse the repository at this point in the history
Add section for Sphinx themes
  • Loading branch information
stevepiercy authored Apr 13, 2023
2 parents fde5daa + 3520c8b commit bdce4f8
Showing 1 changed file with 20 additions and 6 deletions.
26 changes: 20 additions & 6 deletions docs/contributing/documentation/sphinx-extensions.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,29 @@
---
myst:
html_meta:
"description": "Sphinx extensions"
"property=og:description": "Sphinx extensions"
"property=og:title": "Sphinx extensions"
"keywords": "Documentation, Plone, Sphinx, reStructuredText, extensions"
"description": "Sphinx themes and extensions"
"property=og:description": "Sphinx themes and extensions"
"property=og:title": "Sphinx themes and extensions"
"keywords": "Documentation, Plone, Sphinx, reStructuredText, MyST, Markdown, themes, sphinx-book-theme, pydata_sphinx_theme, extensions"
---

(contributing-sphinx-extensions)=
(contributing-sphinx-themes-and-extensions)=

# Sphinx extensions
# Sphinx themes and extensions

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

## Themes

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).
See their documentation for features, tips, and tricks that you might want to include in your documentation.

We minimize the customizations of these themes as much as possible.
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`.


## Extensions

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

Expand Down

0 comments on commit bdce4f8

Please sign in to comment.