diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index dd75cefc..f523c543 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -1,6 +1,6 @@ name: Deploy documentation website -on: [push, pull_request, workflow_dispatch] +on: [pull_request, workflow_dispatch] jobs: deploy: runs-on: ubuntu-latest @@ -9,7 +9,7 @@ jobs: - name: Set up Python uses: actions/setup-python@v1 with: - python-version: '3.11' + python-version: '3.12' - name: Install dependencies run: | pip install -e."[develop]" diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml index e0b253a0..153741ea 100644 --- a/.github/workflows/tests.yml +++ b/.github/workflows/tests.yml @@ -1,4 +1,4 @@ -name: Build +name: Run unit tests on: push: @@ -17,12 +17,12 @@ jobs: - name: Set up Python uses: actions/setup-python@v1 with: - python-version: '3.10' + python-version: '3.12' - name: Install dependencies run: | python -m pip install --upgrade pip pip install -e .[develop] - - name: Build + - name: Run unit tests run: | pytest src/tests/test_ODE.py pytest src/tests/test_JumpProcess.py diff --git a/docs/guidelines.md b/docs/guidelines.md index daab38eb..c5d4c61a 100644 --- a/docs/guidelines.md +++ b/docs/guidelines.md @@ -66,9 +66,9 @@ Documentation consists of both the technical matter about the code as well as ba The Sphinx setup provides the usage of both `.rst` file, i.e. [restructuredtext](https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html) as well as `.md` files, i.e. [Markdown](https://www.markdownguide.org/basic-syntax/). The latter is generally experienced as easier to write, while the former provides more advanced functionalities. Existing pages of the documentation reside in `~/docs/` and can be adjusted directly. In case you want to build the documentation locally, make sure you have the development dependencies installed (`pip install -e ".[develop]"`) to run the sphinx build script. To build locally, run the following command in the home directory, ```bash -python setup.py build_sphinx +python sphinx-build docs build/sphinx/ ``` -which compiles the html-website in the directory `build/html`. Double click any of the `html` file in the folder to open the website in your browser (no server required). Or alternatively, run the following command in the 'docs' directory, +which compiles the html-website in the directory `build/sphinx/html`. Double click any of the `html` file in the folder to open the website in your browser (no server required). Or alternatively, run the following command in the 'docs' directory, ```bash make html ```