Update libraries due to breaking versions.

Major version in sphinx-bibtex is incompatible with this library's sphinx version. This commit restricts the version number: jupyter-book/jupyter-book#1137 (comment) The latest release of jinja2 introduces was not compatible with this library's sphinx version. This commit restricts the version number: readthedocs/readthedocs.org#9038 (comment) isort is used in pre-commit hook but does not come with the requirements-dev.txt. This commit adds it to have it available during development. Building the docs with a Jupyter notebook in it requires pandoc. The README is updated to include an installation instruction. Using conda is suggested in this stackoverflow question: https://stackoverflow.com/questions/62398231/building-docs-fails-due-to-missing-pandoc
JarnoRFB · Jun 14, 2023 · 2663f56 · 2663f56
1 parent 0f3e0a2
commit 2663f56
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -59,6 +59,7 @@ in the project's root directory.
 If you want to contribute to the documentation, run
 
     pip install -r requirements-doc.txt
+    conda install pandoc
 
 to install the necessary packages for building the sphinx documentation.
 

diff --git a/requirements-dev.txt b/requirements-dev.txt
@@ -10,4 +10,4 @@ flake8
 pep8-naming
 flake8-docstrings
 pre-commit
-
+isort
diff --git a/requirements-doc.txt b/requirements-doc.txt
@@ -1,6 +1,7 @@
 -r requirements.txt
 sphinx~=2.1.2 
 sphinx_rtd_theme~=0.4.3
-sphinxcontrib-bibtex
+sphinxcontrib-bibtex<2.0.0
 nbsphinx
-doc8
+doc8
+jinja2<3.1