Skip to content

Commit

Permalink
Update documentation stack / tox.ini for building documentation
Browse files Browse the repository at this point in the history
* Update exhale, sphinx, ... to fix some incompatibilities
* Set up tox.ini for building documentation
  • Loading branch information
dweindl committed Nov 29, 2023
1 parent f87a21a commit 2ba39f4
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 9 deletions.
16 changes: 8 additions & 8 deletions documentation/rtd_requirements.txt
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
# NOTE: relative paths are expected to be relative to the repository root
sphinx<7
sphinx
mock>=5.0.2
setuptools==67.7.2
setuptools>=67.7.2
pysb>=1.11.0
matplotlib==3.7.1
nbsphinx==0.9.1
nbsphinx>=0.9.1
nbformat==5.8.0
recommonmark>=0.7.1
sphinx_rtd_theme>=1.2.0
petab[vis]>=0.2.0
sphinx-autodoc-typehints==1.23.0
sphinx-autodoc-typehints
git+https://github.com/readthedocs/sphinx-hoverxref@main
ipython==8.13.2
breathe==4.35.0
ipython>=8.13.2
breathe>=4.35.0
#exhale>=0.3.5
-e git+https://github.com/mithro/sphinx-contrib-mithro#egg=sphinx-contrib-exhale-multiproject&subdirectory=sphinx-contrib-exhale-multiproject
sphinxcontrib-matlabdomain<0.19.0
sphinxcontrib-matlabdomain>=0.20.0
sphinxcontrib-napoleon>=0.7
pygments==2.15.1
pygments>=2.15.1
Jinja2==3.1.2
git+https://github.com/readthedocs/readthedocs-sphinx-ext
ipykernel
Expand Down
2 changes: 1 addition & 1 deletion documentation/rtd_requirements2.txt
Original file line number Diff line number Diff line change
@@ -1 +1 @@
exhale>=0.3.6
-e git+https://github.com/svenevs/exhale.git@a1a8551321e246e3ab81f5456e04a8159804595b#egg=exhale
24 changes: 24 additions & 0 deletions tox.ini
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
[tox]
env_list =
py311
minversion = 4.11.3
envlist =
doc

[testenv]
passenv = AMICI_PARALLEL_COMPILE,CC,CXX

[testenv:doc]
description =
Build documentation
deps =
-r documentation/rtd_requirements.txt
-r documentation/rtd_requirements2.txt
# don't install the package, this is already handled by `deps` above
skip_install = true
change_dir = documentation/
allowlist_externals =
rm
commands =
rm -rf amici_models/ _doxyoutput_amici_cpp/ _exhale_cpp_api/ _exhale_matlab_api/
sphinx-build -T -E -W --keep-going -b readthedocs -d _build/doctrees-readthedocs -D language=en . _build/html

0 comments on commit 2ba39f4

Please sign in to comment.