Skip to content

Commit c964284

Browse files
zingalezingale
authored
add a doc build github action (#113)
this also fixes a few import errors that the docs picked up
1 parent 98ebfc1 commit c964284

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+914
-867
lines changed

‎.github/workflows/docs-test.yml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
name: docs build
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- main
10+
11+
jobs:
12+
docs:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- uses: actions/checkout@v3
17+
with:
18+
fetch-depth: 0
19+
- name: Install pandoc and doxygen
20+
run: |
21+
sudo apt install pandoc doxygen
22+
23+
- name: Setup Python
24+
uses: actions/setup-python@v4
25+
with:
26+
python-version: '3.10'
27+
28+
- name: Cache pip
29+
uses: actions/cache@v3
30+
with:
31+
# this path is specific to Ubuntu
32+
path: ~/.cache/pip
33+
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
34+
restore-keys: |
35+
${{ runner.os }}-pip-
36+
37+
- name: Install dependencies
38+
run: pip install -r ./requirements.txt
39+
40+
- name: Install pyro
41+
run: python setup.py install
42+
43+
- name: Build docs
44+
run: |
45+
cd docs/
46+
PYTHONPATH=$GITHUB_WORKSPACE make SPHINXOPTS=-v html

‎docs/source/advection.problems.rst‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,34 @@
1-
advection\.problems package
2-
===========================
1+
advection.problems package
2+
==========================
33

44
.. automodule:: advection.problems
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
88

99
Submodules
1010
----------
1111

12-
advection\.problems\.smooth module
13-
----------------------------------
12+
advection.problems.smooth module
13+
--------------------------------
1414

1515
.. automodule:: advection.problems.smooth
16-
:members:
17-
:undoc-members:
18-
:show-inheritance:
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
1919

20-
advection\.problems\.test module
21-
--------------------------------
20+
advection.problems.test module
21+
------------------------------
2222

2323
.. automodule:: advection.problems.test
24-
:members:
25-
:undoc-members:
26-
:show-inheritance:
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
2727

28-
advection\.problems\.tophat module
29-
----------------------------------
28+
advection.problems.tophat module
29+
--------------------------------
3030

3131
.. automodule:: advection.problems.tophat
32-
:members:
33-
:undoc-members:
34-
:show-inheritance:
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:

‎docs/source/advection.rst‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,33 @@ advection package
22
=================
33

44
.. automodule:: advection
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
88

99
Subpackages
1010
-----------
1111

1212
.. toctree::
13+
:maxdepth: 4
1314

14-
advection.problems
15+
advection.problems
1516

1617
Submodules
1718
----------
1819

19-
advection\.advective\_fluxes module
20-
-----------------------------------
20+
advection.advective\_fluxes module
21+
----------------------------------
2122

2223
.. automodule:: advection.advective_fluxes
23-
:members:
24-
:undoc-members:
25-
:show-inheritance:
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
2627

27-
advection\.simulation module
28-
----------------------------
28+
advection.simulation module
29+
---------------------------
2930

3031
.. automodule:: advection.simulation
31-
:members:
32-
:undoc-members:
33-
:show-inheritance:
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:

‎docs/source/advection_fv4.problems.rst‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
advection\_fv4\.problems package
2-
================================
1+
advection\_fv4.problems package
2+
===============================
33

44
.. automodule:: advection_fv4.problems
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
88

99
Submodules
1010
----------
1111

12-
advection\_fv4\.problems\.smooth module
13-
---------------------------------------
12+
advection\_fv4.problems.smooth module
13+
-------------------------------------
1414

1515
.. automodule:: advection_fv4.problems.smooth
16-
:members:
17-
:undoc-members:
18-
:show-inheritance:
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:

‎docs/source/advection_fv4.rst‎

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2,40 +2,41 @@ advection\_fv4 package
22
======================
33

44
.. automodule:: advection_fv4
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
88

99
Subpackages
1010
-----------
1111

1212
.. toctree::
13+
:maxdepth: 4
1314

14-
advection_fv4.problems
15+
advection_fv4.problems
1516

1617
Submodules
1718
----------
1819

19-
advection\_fv4\.fluxes module
20-
-----------------------------
20+
advection\_fv4.fluxes module
21+
----------------------------
2122

2223
.. automodule:: advection_fv4.fluxes
23-
:members:
24-
:undoc-members:
25-
:show-inheritance:
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
2627

27-
advection\_fv4\.interface module
28-
--------------------------------
28+
advection\_fv4.interface module
29+
-------------------------------
2930

3031
.. automodule:: advection_fv4.interface
31-
:members:
32-
:undoc-members:
33-
:show-inheritance:
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:
3435

35-
advection\_fv4\.simulation module
36-
---------------------------------
36+
advection\_fv4.simulation module
37+
--------------------------------
3738

3839
.. automodule:: advection_fv4.simulation
39-
:members:
40-
:undoc-members:
41-
:show-inheritance:
40+
:members:
41+
:undoc-members:
42+
:show-inheritance:

‎docs/source/advection_nonuniform.problems.rst‎

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,26 @@
1-
advection\_nonuniform\.problems package
2-
=======================================
1+
advection\_nonuniform.problems package
2+
======================================
33

44
.. automodule:: advection_nonuniform.problems
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
88

99
Submodules
1010
----------
1111

12-
advection\_nonuniform\.problems\.slotted module
13-
-----------------------------------------------
12+
advection\_nonuniform.problems.slotted module
13+
---------------------------------------------
1414

1515
.. automodule:: advection_nonuniform.problems.slotted
16-
:members:
17-
:undoc-members:
18-
:show-inheritance:
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
19+
20+
advection\_nonuniform.problems.test module
21+
------------------------------------------
22+
23+
.. automodule:: advection_nonuniform.problems.test
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:

‎docs/source/advection_nonuniform.rst‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,33 @@ advection\_nonuniform package
22
=============================
33

44
.. automodule:: advection_nonuniform
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
88

99
Subpackages
1010
-----------
1111

1212
.. toctree::
13+
:maxdepth: 4
1314

14-
advection_nonuniform.problems
15+
advection_nonuniform.problems
1516

1617
Submodules
1718
----------
1819

19-
advection\_nonuniform\.advective\_fluxes module
20-
-----------------------------------------------
20+
advection\_nonuniform.advective\_fluxes module
21+
----------------------------------------------
2122

2223
.. automodule:: advection_nonuniform.advective_fluxes
23-
:members:
24-
:undoc-members:
25-
:show-inheritance:
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:
2627

27-
advection\_nonuniform\.simulation module
28-
----------------------------------------
28+
advection\_nonuniform.simulation module
29+
---------------------------------------
2930

3031
.. automodule:: advection_nonuniform.simulation
31-
:members:
32-
:undoc-members:
33-
:show-inheritance:
32+
:members:
33+
:undoc-members:
34+
:show-inheritance:

‎docs/source/advection_rk.rst‎

Lines changed: 13 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,25 @@ advection\_rk package
22
=====================
33

44
.. automodule:: advection_rk
5-
:members:
6-
:undoc-members:
7-
:show-inheritance:
8-
9-
Subpackages
10-
-----------
11-
12-
.. toctree::
13-
14-
advection_rk.problems
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
158

169
Submodules
1710
----------
1811

19-
advection\_rk\.fluxes module
20-
----------------------------
12+
advection\_rk.fluxes module
13+
---------------------------
2114

2215
.. automodule:: advection_rk.fluxes
23-
:members:
24-
:undoc-members:
25-
:show-inheritance:
16+
:members:
17+
:undoc-members:
18+
:show-inheritance:
2619

27-
advection\_rk\.simulation module
28-
--------------------------------
20+
advection\_rk.simulation module
21+
-------------------------------
2922

3023
.. automodule:: advection_rk.simulation
31-
:members:
32-
:undoc-members:
33-
:show-inheritance:
24+
:members:
25+
:undoc-members:
26+
:show-inheritance:

0 commit comments

Comments
 (0)