Skip to content

Commit

Permalink
Adds loose pinning of dev docs requirements to ensure correct builds …
Browse files Browse the repository at this point in the history
…+ add required extension sphinxcontrib.jquery
  • Loading branch information
Benjamin Bach authored and José Redrejo committed Oct 8, 2024
1 parent f16551c commit f1b712a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
8 changes: 7 additions & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,13 @@ def process_docstring(app, what, name, obj, options, lines):

# 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.autodoc", "sphinx.ext.viewcode", "m2r", "notfound.extension"]
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.viewcode",
"m2r",
"notfound.extension",
"sphinxcontrib.jquery",
]

linkcheck_ignore = [
"https://groups.google.com/a/learningequality.org/forum/#!forum/dev"
Expand Down
7 changes: 5 additions & 2 deletions requirements/docs.txt
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
-r base.txt

# These are for building the docs
sphinx

# Sphinx stack requires a version of requests that's incompatible with Morango, so downgrading
sphinx>=6,<7
sphinx-intl
sphinx-rtd-theme
# We want to ensure the latest version of sphinx-rtd-theme that has sphinxcontrib-jquery as a dependency
sphinx-rtd-theme~=2.0
sphinx-autobuild
m2r
sphinx-notfound-page

0 comments on commit f1b712a

Please sign in to comment.