Skip to content

Commit

Permalink
Re-activate sphinx needs and fix one dependency.
Browse files Browse the repository at this point in the history
This was a mistake on previous commit.

For On Python 3.9, building the docs caused a jinja error
during nbconvert that requires pinning back to Jinja2==3.0.3
so that was also done.

See: sphinx-doc/sphinx#10289
  • Loading branch information
ntouran committed Aug 9, 2023
1 parent e30d56d commit 0496e30
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ def setup(app):
"sphinx_gallery.gen_gallery",
"sphinx.ext.imgconverter", # to convert GH Actions badge SVGs to PNG for LaTeX
"sphinxcontrib.plantuml",
# "sphinx_needs",
"sphinx_needs",
"sphinx_rtd_theme", # needed here for loading jquery in sphinx 6
"sphinxcontrib.jquery", # see https://github.com/readthedocs/sphinx_rtd_theme/issues/1452
]
Expand Down
4 changes: 2 additions & 2 deletions doc/requirements-docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ ipykernel==6.25.1
# used to generate UML diagrams
pylint==2.17.5

# used in numpydoc
Jinja2==3.1.2
# used in numpydoc and nbconvert
Jinja2==3.0.3

# deal with missing jquery errors
sphinxcontrib-jquery==4.1
2 changes: 1 addition & 1 deletion doc/requirements/srsd.rst
Original file line number Diff line number Diff line change
Expand Up @@ -510,7 +510,7 @@ TODO: This is completed by the :doc:`Settings Report </user/inputs/settings_repo
:id: REQ_LATTICE_OUTPUTS
:status: needs implementation, needs test

.. reg:: The reactor package shall check input for basic correctness.
.. req:: The reactor package shall check input for basic correctness.
:id: REQ_REACTOR_CORRECTNESS
:status: needs implementation, needs test

Expand Down

0 comments on commit 0496e30

Please sign in to comment.