mirror of
https://github.com/pacnpal/django-anymail.git
synced 2025-12-20 03:41:05 -05:00
Docs: prep for upcoming RTD build changes
Read the Docs is changing their build process. Some docs/conf.py manipulation they used to do automatically now must be manually included. https://about.readthedocs.com/blog/2024/07/addons-by-default/ Related changes: * Drop our version-alert.js. RTD's new "addons" includes equivalent warning on unreleased versions. * Integrate Google Analytics via sphinxcontrib-googleanalytics when GOOGLE_ANALYTICS_ID is set in docs build environment.
This commit is contained in:
26
docs/conf.py
26
docs/conf.py
@@ -15,7 +15,7 @@ from pathlib import Path
|
||||
|
||||
from anymail import VERSION as PACKAGE_VERSION
|
||||
|
||||
ON_READTHEDOCS = os.environ.get("READTHEDOCS", None) == "True"
|
||||
ON_READTHEDOCS = os.environ.get("READTHEDOCS") == "True"
|
||||
DOCS_PATH = Path(__file__).parent
|
||||
PROJECT_ROOT_PATH = DOCS_PATH.parent
|
||||
|
||||
@@ -31,7 +31,12 @@ needs_sphinx = "1.0"
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||
extensions = ["sphinx.ext.intersphinx", "sphinx.ext.extlinks", "sphinx_rtd_theme"]
|
||||
extensions = [
|
||||
"sphinx.ext.intersphinx",
|
||||
"sphinx.ext.extlinks",
|
||||
"sphinx_rtd_theme",
|
||||
"sphinxcontrib.googleanalytics",
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ["_templates"]
|
||||
@@ -96,6 +101,12 @@ pygments_style = "sphinx"
|
||||
|
||||
# -- Options for HTML output ---------------------------------------------------
|
||||
|
||||
# Set canonical URL from the Read the Docs Domain.
|
||||
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
|
||||
|
||||
# Let templates know whether the build is running on Read the Docs.
|
||||
html_context = {"READTHEDOCS": ON_READTHEDOCS}
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
@@ -271,14 +282,23 @@ intersphinx_mapping = {
|
||||
"urllib3": ("https://urllib3.readthedocs.io/en/stable/", None),
|
||||
}
|
||||
|
||||
# -- Options for Google Analytics -------------------------------------------
|
||||
|
||||
googleanalytics_id = os.environ.get("GOOGLE_ANALYTICS_ID", "")
|
||||
googleanalytics_enabled = bool(googleanalytics_id)
|
||||
|
||||
if not googleanalytics_enabled:
|
||||
# Work around https://github.com/sphinx-contrib/googleanalytics/issues/14.
|
||||
googleanalytics_id = "IGNORED"
|
||||
|
||||
|
||||
# -- App setup --------------------------------------------------------------
|
||||
def setup(app):
|
||||
app.add_css_file("anymail-theme.css")
|
||||
# Inline <script> for anymail-config.js to avoid non-async JS load:
|
||||
# app.add_js_file("anymail-config.js")
|
||||
anymail_config_js = (DOCS_PATH / "_static/anymail-config.js").read_text()
|
||||
app.add_js_file(None, body=anymail_config_js)
|
||||
app.add_js_file("version-alert.js", **{"async": "async"})
|
||||
app.add_js_file("table-formatting.js", **{"async": "async"})
|
||||
app.add_js_file("https://unpkg.com/rate-the-docs", **{"async": "async"})
|
||||
|
||||
|
||||
Reference in New Issue
Block a user