Skip to content

Commit

Permalink
twisted#12012 Fix loading JQuery for Read The Docs theme. (twisted#12013
Browse files Browse the repository at this point in the history
)
  • Loading branch information
glyph committed Oct 11, 2023
2 parents 88172f7 + eb7b38a commit 0a41d60
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 25 deletions.
5 changes: 0 additions & 5 deletions docs/_static/js/custom.js

This file was deleted.

20 changes: 3 additions & 17 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@

import sphinx_rtd_theme

from twisted import version as twisted_version_object

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
Expand All @@ -37,18 +39,10 @@
# ones.
extensions = [
"sphinx.ext.intersphinx",
"sphinxcontrib.jquery",
"pydoctor.sphinx_ext.build_apidocs",
]

try:
import rst2pdf.pdfbuilder

extensions.append("rst2pdf.pdfbuilder")
except ImportError:
pass

from twisted import version as twisted_version_object

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

Expand Down Expand Up @@ -106,14 +100,6 @@
html_static_path = ["_static"]


# These paths are either relative to html_static_path
# or fully qualified paths (eg. https://...)
html_js_files = [
"js/custom.js",
# Here we have a Sphinx HTML injection hack to make the JS script load without blocking.
'https://sidecar.gitter.im/dist/sidecar.v1.js" defer hack="',
]

# Output file base name for HTML help builder.
htmlhelp_basename = "Twisteddoc"

Expand Down
5 changes: 2 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -61,9 +61,8 @@ test = [
# release scripts and process.
dev-release = [
"towncrier ~= 23.6",
"pydoctor ~= 23.4.0",
"sphinx-rtd-theme ~= 1.2",
"readthedocs-sphinx-ext ~= 2.2",
"pydoctor ~= 23.9.0",
"sphinx-rtd-theme ~= 1.3",
"sphinx >= 6, <7",
]

Expand Down
3 changes: 3 additions & 0 deletions src/twisted/newsfragments/12012.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
The search and version navigation for the documentation hosted on
Read The Docs was fixed.
This was a regression introduced with 23.8.0.

0 comments on commit 0a41d60

Please sign in to comment.