You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/contrib/02_continuous_integration.md
+22-2Lines changed: 22 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,8 @@
1
1
# Continuous Integration in pySDC
2
2
3
3
Any commit in `pySDC` are tested within by GitHub continuous integration (CI). You can see in in the [action panel](https://github.com/Parallel-in-Time/pySDC/actions) the tests for each branches.
4
-
Those tests can be divided in two main categories : code linting and code testing.
4
+
Those tests can be divided in two main categories : [code linting](#code-linting) and [code testing](#code-testing).
5
+
Finally, the CI also build artifacts that are used to generate the documentation website (see http://parallel-in-time.org/pySDC/), more details given in the [documentation generation](#documentation-generation) section.
5
6
6
7
## Code linting
7
8
@@ -29,7 +30,7 @@ Some style rules that are automatically enforced :
29
30
- lines should be not longer than 120 characters
30
31
- arithmetic operators (`+`, `*`, ...) should be separated with variables by one empty space
31
32
32
-
# Code testing
33
+
## Code testing
33
34
34
35
This is done using[ `pytest`](https://docs.pytest.org/en/7.2.x/), and runs all the tests written in the `pySDC/tests` folder. You can run those locally in the root folder of `pySDC` using :
35
36
@@ -47,5 +48,24 @@ pytest -v pySDC/tests
47
48
> pytest -v pySDC/tests/test_nodes.py # only test nodes generation
48
49
>```
49
50
51
+
## Documentation generation
52
+
53
+
To check the documentation generation, you can waitfor all the CI tasks to download the `docs` artifacts, unzip it and open the `index.html` file there with you favorite browser. However, when you are working on documentation (of the project, of the code, etc ...), you can already build and check the website locally :
Then you can open `docs/build/html/index.html` using you favorite browser and check how your own documentation looks like on the website.
65
+
66
+
> :bell:**Important** : running all the tests is necessary to generate graphs and images used by the website.
67
+
> But you can still generate the website without it : just all images for the tutorials, projects and playgrounds will be missing.
68
+
> This approach can be considered for local testing of your contribution when it does not concern parts containing images (_i.e_ project or code documentation).
69
+
50
70
:arrow_left:[Back to Pull Request Recommendation](./01_pull_requests.md) ---
51
71
:arrow_right:[Next to Naming Conventions](./03_naming_conventions.md)
0 commit comments