documentation".
+html_title = "%(project)s v%(release)s" % {"project": project, "release": release}
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
html_theme_options = {
+ "extra_footer": """The text and illustrations in this website are licensed by the Plone Foundation under a Creative Commons Attribution 4.0 International license. Plone and the Plone® logo are registered trademarks of the Plone Foundation, registered in the United States and other countries. For guidelines on the permitted uses of the Plone trademarks, see https://plone.org/foundation/logo. All other trademarks are owned by their respective owners.
+ Pull request previews by Read the Docs.
""",
+ "footer_end": ["version.html"],
+ "icon_links": [
+ {
+ "name": "GitHub",
+ "url": "https://github.com/plone/plone.restapi",
+ "icon": "fa-brands fa-square-github",
+ "type": "fontawesome",
+ "attributes": {
+ "target": "_blank",
+ "rel": "noopener me",
+ "class": "nav-link custom-fancy-css"
+ }
+ },
+ {
+ "name": "Mastodon",
+ "url": "https://plone.social/@plone",
+ "icon": "fa-brands fa-mastodon",
+ "type": "fontawesome",
+ "attributes": {
+ "target": "_blank",
+ "rel": "noopener me",
+ "class": "nav-link custom-fancy-css"
+ }
+ },
+ {
+ "name": "Twitter",
+ "url": "https://twitter.com/plone",
+ "icon": "fa-brands fa-square-twitter",
+ "type": "fontawesome",
+ "attributes": {
+ "target": "_blank",
+ "rel": "noopener me",
+ "class": "nav-link custom-fancy-css"
+ }
+ },
+ ],
+ "logo": {
+ "text": html_title,
+ },
+ "navigation_with_keys": True,
"path_to_docs": "docs",
- "repository_url": "https://github.com/plone/plone.restapi",
"repository_branch": "master",
- "use_repository_button": True,
- "use_issues_button": True,
+ "repository_url": "https://github.com/plone/plone.restapi",
+ "search_bar_text": "Search", # TODO: Confirm usage of search_bar_text
"use_edit_page_button": True,
- "extra_footer": """The text and illustrations in this website are licensed by the Plone Foundation under a Creative Commons Attribution 4.0 International license. Plone and the Plone® logo are registered trademarks of the Plone Foundation, registered in the United States and other countries. For guidelines on the permitted uses of the Plone trademarks, see https://plone.org/foundation/logo. All other trademarks are owned by their respective owners.
""",
+ "use_issues_button": True,
+ "use_repository_button": True,
}
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
-# html_theme_options = {}
-
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
-# The name for this set of Sphinx documents. If None, it defaults to
-# " v documentation".
-html_title = "%(project)s v%(release)s" % {"project": project, "release": release}
-
# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-# html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-# html_favicon = None
-
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
@@ -274,12 +311,14 @@ def patch_pygments_to_highlight_jsonschema():
# For more information see:
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html
myst_enable_extensions = [
- "deflist", # You will be able to utilise definition lists
+ "deflist", # Support definition lists.
# https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#definition-lists
- "linkify", # Identify “bare” web URLs and add hyperlinks.
+ "linkify", # Identify "bare" web URLs and add hyperlinks.
"colon_fence", # You can also use ::: delimiters to denote code fences,\
# instead of ```.
- "substitution", # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2
+ "substitution", # plone.restapi \
+ # https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#substitutions-with-jinja2
+ "html_image", # For inline images. See https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#html-images
]
myst_substitutions = {
diff --git a/news/1815.documentation b/news/1815.documentation
new file mode 100644
index 000000000..dd9891dfe
--- /dev/null
+++ b/news/1815.documentation
@@ -0,0 +1 @@
+Use Plone Sphinx Theme for documentation. Build docs when there are changes to http-examples. @stevepiercy
diff --git a/requirements-docs.txt b/requirements-docs.txt
index a522f6530..4b3918f39 100644
--- a/requirements-docs.txt
+++ b/requirements-docs.txt
@@ -1,20 +1,10 @@
-docutils<0.17,>=0.15 # sphinx-book-theme 0.2.0 has requirement docutils<0.17,>=0.15
-Sphinx<5,>=3 # sphinx-book-theme 0.3.3 has requirement sphinx<5,>=3
-sphinxcontrib-applehelp==1.0.4 # newer versions require sphinx 5
-sphinxcontrib-devhelp==1.0.2 # newer versions require sphinx 5
-sphinxcontrib-htmlhelp==2.0.1 # newer versions require sphinx 5
-sphinxcontrib-qthelp==1.0.3 # newer versions require sphinx 5
-sphinxcontrib-serializinghtml==1.1.5 # newer versions require sphinx 5
-jsx-lexer
-lesscpy
linkify-it-py
myst-parser
+plone-sphinx-theme
+setuptools # required by sphinxcontrib.httpexample, remove when it migrates to importlib
sphinx-autobuild
-sphinx-book-theme
sphinx-copybutton
-sphinx-sitemap
-sphinx-togglebutton
sphinxcontrib.httpdomain
sphinxcontrib.httpexample
-sphinxcontrib-spelling
sphinxext-opengraph
+vale==2.30.0