Add sphinx-examples extension

stevepiercy · stevepiercy · commit 55170bc59806 · 2024-05-09T17:29:50.000-07:00
diff --git a/docs/contributing/documentation/themes-and-extensions.md b/docs/contributing/documentation/themes-and-extensions.md
@@ -42,6 +42,7 @@ We use several MyST and Sphinx extensions to enhance the presentation of Plone d
 
 -   [`myst_parser`](https://myst-parser.readthedocs.io/en/latest/) parses MyST, a rich and extensible flavour of Markdown for authoring documentation.
 -   [`sphinx-design`](https://sphinx-design.readthedocs.io/en/latest/), with a configuration name of `sphinx_design`, adds grids, cards, icons, badges, buttons, tabs, and dropdowns.
+-   [`sphinx-examples`](https://ebp-sphinx-examples.readthedocs.io/en/latest/) adds "example snippets" that allow you to show off source Markdown and the result of rendering it in Sphinx.
 -   [`sphinx-notfound-page`](https://sphinx-notfound-page.readthedocs.io/en/latest/index.html), with a configuration name of `notfound.extension`, creates a custom 404 page and helps generate proper static resource links to render the page properly.
 -   [`sphinx.ext.autodoc`](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html) pulls in documentation from Python docstrings to generate reStructuredText which in turn gets parsed by Sphinx and rendered to the output format.
     It is used by {doc}`/plone.api/index`.
diff --git a/requirements.txt b/requirements.txt
@@ -9,6 +9,7 @@ sphinx-autobuild
 sphinx-book-theme==0.3.3  # Temporary pin until we can sort out HTML refactoring.
 sphinx-copybutton
 sphinx-design  # Documentation only
+sphinx-examples  # Documentation only
 sphinx-notfound-page  # Documentation only
 sphinx-reredirects
 sphinx-sitemap
