Skip to content

Commit

Permalink
update docs / workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
dweindl committed Dec 1, 2023
1 parent 10455bc commit f418276
Show file tree
Hide file tree
Showing 4 changed files with 3 additions and 42 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/test_doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -67,10 +67,10 @@ jobs:
sudo apt-get update \
&& sudo apt-get install -y \
pandoc \
python3-venv
&& pip install tox
- name: Set up SWIG
uses: ./.github/actions/setup-swig

- name: Run sphinx
run: scripts/run-sphinx.sh
run: tox -e doc
8 changes: 1 addition & 7 deletions documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The legacy GitHub Pages URL https://amici-dev.github.io/AMICI/ is set up as a
redirect to RTD.

The main configuration file is `documentation/conf.py` and the documentation
is generated using `scripts/run-sphinx.sh`. The documentation is written to
is generated using `tox -e doc`. The documentation is written to
`documentation/_build/`.

The documentation comprises:
Expand Down Expand Up @@ -50,12 +50,6 @@ Matlab documentation is processed by
[mtoc++](https://www.morepas.org/software/mtocpp/docs/tools.html).
This is configured in `matlab/mtoc/config`.

#### Python documentation

Python documentation is processed by doxygen and doxypypy using the script and
filters in `scripts/`.


## Writing documentation

### Out-of-source documentation
Expand Down
17 changes: 0 additions & 17 deletions scripts/run-sphinx-hasenv.sh

This file was deleted.

16 changes: 0 additions & 16 deletions scripts/run-sphinx.sh

This file was deleted.

0 comments on commit f418276

Please sign in to comment.