Skip to content

Commit 710e6f4

Browse files
authored
separate the mesh docs into their own section (#221)
1 parent 9108a53 commit 710e6f4

File tree

5 files changed

+231
-128
lines changed

5 files changed

+231
-128
lines changed

docs/source/index.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,14 @@ pyro: a python hydro code
2222
running
2323
output
2424
problems
25+
26+
.. toctree::
27+
maxdepth: 1
28+
:caption: mesh
29+
2530
mesh_basics
2631
mesh-examples.ipynb
32+
spherical-mesh.ipynb
2733

2834
.. toctree::
2935
:maxdepth: 1

docs/source/mesh_basics.rst

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -96,15 +96,6 @@ Note that each variable needs to specify a BC—this allows us to do
9696
different actions for each variable (for example, some may do even
9797
reflection while others may do odd reflection).
9898

99-
Jupyter notebook
100-
----------------
101-
102-
A Jupyter notebook that illustrates some of the basics of working with
103-
the grid is provided as `mesh-examples.ipynb <https://github.com/python-hydro/pyro2/blob/main/pyro/mesh/mesh-examples.ipynb>`_. This will
104-
demonstrate, for example, how to use the :func:`ArrayIndexer <pyro.mesh.array_indexer.ArrayIndexer>` methods to
105-
construct differences.
106-
107-
10899
Tests
109100
-----
110101

docs/source/spherical-mesh.ipynb

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../../pyro/mesh/spherical-mesh.ipynb

pyro/mesh/mesh-examples.ipynb

Lines changed: 25 additions & 119 deletions
Large diffs are not rendered by default.

pyro/mesh/spherical-mesh.ipynb

Lines changed: 199 additions & 0 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)