Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restore support for Mermaid. #38

Merged
merged 2 commits into from
Nov 14, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@
"sphinx_sitemap",
"sphinxcontrib.httpdomain", # plone.restapi
"sphinxcontrib.httpexample", # plone.restapi
# "sphinxcontrib.mermaid",
"sphinxcontrib.mermaid",
"sphinxcontrib.video",
"sphinxext.opengraph",
]
Expand Down Expand Up @@ -358,7 +358,7 @@


# -- Mermaid configuration ----------------------------------
# mermaid_version = "10.9.1"
mermaid_version = "11.2.0"


# -- OpenGraph configuration ----------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,6 @@ These extensions are built in and can be activated by respective entries in the
- [`sphinxcontrib.httpexample`](https://sphinxcontrib-httpexample.readthedocs.io/en/latest/) enhances `sphinxcontrib-httpdomain` by generating RESTful HTTP API call examples for different tools from a single HTTP request example.
Supported tools include [`curl`](https://curl.se/), [`wget`](https://www.gnu.org/software/wget/), [`httpie`](https://httpie.io/), and [`python-requests`](https://requests.readthedocs.io/en/latest/).
It's used by Plone's {doc}`plone:plone.restapi/docs/source/index`.
% - [`sphinxcontrib.mermaid`](https://pypi.org/project/sphinxcontrib-mermaid/) allows you to embed [Mermaid](https://mermaid.js.org/) graphs in your documents, including general flowcharts, sequence diagrams, and Gantt charts.
- [`sphinxcontrib.mermaid`](https://pypi.org/project/sphinxcontrib-mermaid/) allows you to embed [Mermaid](https://mermaid.js.org/) graphs in your documents, including general flowcharts, sequence diagrams, and Gantt charts.
- [`sphinxcontrib.video`](https://pypi.org/project/sphinxcontrib-video/) allows you to embed local videos as defined by the HTML5 standard.
- [`sphinxext.opengraph`](https://pypi.org/project/sphinxext-opengraph/) generates [OpenGraph metadata](https://ogp.me/).
1 change: 1 addition & 0 deletions news/38.feature
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Restore support for Mermaid. @stevepiercy
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ docs = [
"sphinx-copybutton",
"sphinx-design",
"sphinx-examples",
# "sphinxcontrib-mermaid==0.9.2", # See https://github.com/mgaitan/sphinxcontrib-mermaid/issues/137
"sphinxcontrib-mermaid",
"sphinx-notfound-page",
"sphinx-reredirects",
"sphinx-sitemap",
Expand Down
11 changes: 8 additions & 3 deletions requirements-dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,9 @@ pyproject-metadata==0.9.0
pyroma==4.2
# via zest-releaser
pyyaml==6.0.2
# via myst-parser
# via
# myst-parser
# sphinxcontrib-mermaid
readme-renderer==44.0
# via
# twine
Expand All @@ -147,7 +149,7 @@ rich==13.9.4
# via
# sphinx-theme-builder
# twine
setuptools==75.4.0
setuptools==75.5.0
# via
# check-manifest
# pyroma
Expand Down Expand Up @@ -179,6 +181,7 @@ sphinx==7.4.7
# sphinx-sitemap
# sphinxcontrib-httpdomain
# sphinxcontrib-httpexample
# sphinxcontrib-mermaid
# sphinxcontrib-video
# sphinxext-opengraph
sphinx-autobuild==2024.10.3
Expand Down Expand Up @@ -217,6 +220,8 @@ sphinxcontrib-httpexample==1.3
# via plone-sphinx-theme (pyproject.toml)
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-mermaid==1.0.0
# via plone-sphinx-theme (pyproject.toml)
sphinxcontrib-qthelp==2.0.0
# via sphinx
sphinxcontrib-serializinghtml==2.0.0
Expand Down Expand Up @@ -249,7 +254,7 @@ vale==3.9.0.0
# via plone-sphinx-theme (pyproject.toml)
watchfiles==0.24.0
# via sphinx-autobuild
websockets==14.0
websockets==14.1
# via sphinx-autobuild
wheel==0.45.0
# via
Expand Down
9 changes: 7 additions & 2 deletions requirements-docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,9 @@ pygments==2.18.0
# pydata-sphinx-theme
# sphinx
pyyaml==6.0.2
# via myst-parser
# via
# myst-parser
# sphinxcontrib-mermaid
requests==2.32.3
# via sphinx
six==1.16.0
Expand Down Expand Up @@ -96,6 +98,7 @@ sphinx==7.4.7
# sphinx-sitemap
# sphinxcontrib-httpdomain
# sphinxcontrib-httpexample
# sphinxcontrib-mermaid
# sphinxcontrib-video
# sphinxext-opengraph
sphinx-autobuild==2024.10.3
Expand Down Expand Up @@ -130,6 +133,8 @@ sphinxcontrib-httpexample==1.3
# via plone-sphinx-theme (pyproject.toml)
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-mermaid==1.0.0
# via plone-sphinx-theme (pyproject.toml)
sphinxcontrib-qthelp==2.0.0
# via sphinx
sphinxcontrib-serializinghtml==2.0.0
Expand All @@ -150,7 +155,7 @@ uvicorn==0.32.0
# via sphinx-autobuild
watchfiles==0.24.0
# via sphinx-autobuild
websockets==14.0
websockets==14.1
# via sphinx-autobuild
wheel==0.45.0
# via astunparse
2 changes: 1 addition & 1 deletion src/plone_sphinx_theme/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
A Twitter Bootstrap-based Sphinx theme for documentation of Plone packages and projects, inheriting from Sphinx Book Theme and PyData Sphinx Theme.
A Bootstrap-based Sphinx theme for documentation of Plone packages and projects, inheriting from Sphinx Book Theme and PyData Sphinx Theme.
"""
import os
from pathlib import Path
Expand Down