Skip to content

Commit 864e735

Browse files
committed
Fix documentation issues #41 and #42
Issue #41 - Fix old API documentation links: - Update quickstart.md to link to internal API docs - Update 1-Meshes.ipynb API link to internal docs - Update 2-Variables.ipynb API link to internal docs - Update presentations/_quarto.yml to use ReadTheDocs URL Issue #42 - Fix broken image and formatting: - Fix RelaxingMesh.png path from media/ to ../media/ Closes #41, closes #42 Underworld development team with AI support from Claude Code
1 parent b786cbb commit 864e735

File tree

4 files changed

+5
-40
lines changed

4 files changed

+5
-40
lines changed

docs/beginner/quickstart.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,7 @@ In addition to the notebooks in this brief set of examples, there are a number o
1616

1717
- [The Underworld Website / Blog](https://www.underworldcode.org)
1818

19-
- [The API documentation](https://underworldcode.github.io/underworld3/main_api/underworld3/index.html)
20-
(all the modules and functions and their full sets of arguments) is automatically generated from the source code and uses the same rich markdown content as the notebook help text.
21-
22-
- [The API documentation (development branch)](https://underworldcode.github.io/underworld3/development_api/underworld3/index.html)
19+
- [The API documentation](../api/index.md) (all the modules and functions and their full sets of arguments) is automatically generated from the source code. You can also access it via the navigation sidebar.
2320

2421
- The [`underworld3` GitHub repository](https://github.com/underworldcode/underworld3) is the most active development community for the code.
2522

@@ -85,7 +82,7 @@ Digging a bit deeper into `underworld3`, there are many capabilities that requir
8582

8683
In [Example 8](tutorials/8-Particle_Swarms.ipynb), we made small variations to the mesh to conform to basal topography. We did not remesh, so we had to be careful to apply a smooth, analytic displacement to every node. For more general free-surface models, we need to calculate a smooth function using the computed boundary motions (e.g, solving a poisson equation with known boundary displacements as boundary conditions). We need to step through time and it is common to stabilize the surface motions through a surface integral term that accounts for the interface displacement during the timestep. The example below shows an `underworld3` forward model with internal loads timestepped close to isostatic equilibrium.
8784

88-
```{figure} media/RelaxingMesh.png
85+
```{figure} ../media/RelaxingMesh.png
8986
:width: 50%
9087
9188
Stokes flow driven by buoyancy in an annulus defined by two embedded surfaces within an enveloping disk mesh. The surfaces deform in response to the flow. The embedding medium has a very low viscosity but still acts to damp rotational modes. The outer boundary of the disk can be set to a far-field gravitational potential for whole-Earth relaxation models.

docs/beginner/tutorials/1-Meshes.ipynb

Lines changed: 1 addition & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -146,35 +146,7 @@
146146
},
147147
"tags": []
148148
},
149-
"source": [
150-
"There are other pre-built meshes you can try. This is a cuboid divided into regular tetrahedra:\n",
151-
"\n",
152-
"```python\n",
153-
"mesh_usb = uw.meshing.UnstructuredSimplexBox(\n",
154-
" minCoords = (-1.0, -1.0, -1.0),\n",
155-
" maxCoords = (+1.0, +1.0, +1.0),\n",
156-
" cellSize = 0.2,\n",
157-
" regular=True,\n",
158-
" verbose=False,\n",
159-
")\n",
160-
"```\n",
161-
"\n",
162-
"and this is a two-dimensional annulus mesh\n",
163-
"\n",
164-
"\n",
165-
"```python\n",
166-
"mesh_ann = uw.meshing.Annulus(\n",
167-
" radiusOuter=1.0,\n",
168-
" radiusInner=0.547,\n",
169-
" cellSize= 0.5,\n",
170-
" cellSizeOuter=0.033,\n",
171-
" cellSizeInner=0.05,\n",
172-
" verbose=False,\n",
173-
")\n",
174-
"```\n",
175-
"\n",
176-
"The meshing infrastructure for underworld3 is documented here: https://underworldcode.github.io/underworld3/main_api/underworld3/meshing.html"
177-
]
149+
"source": "There are other pre-built meshes you can try. This is a cuboid divided into regular tetrahedra:\n\n```python\nmesh_usb = uw.meshing.UnstructuredSimplexBox(\n minCoords = (-1.0, -1.0, -1.0),\n maxCoords = (+1.0, +1.0, +1.0),\n cellSize = 0.2,\n regular=True,\n verbose=False,\n)\n```\n\nand this is a two-dimensional annulus mesh\n\n\n```python\nmesh_ann = uw.meshing.Annulus(\n radiusOuter=1.0,\n radiusInner=0.547,\n cellSize= 0.5,\n cellSizeOuter=0.033,\n cellSizeInner=0.05,\n verbose=False,\n)\n```\n\nThe meshing infrastructure for underworld3 is documented in the [API documentation](../../api/meshing.md)."
178150
},
179151
{
180152
"cell_type": "code",

docs/beginner/tutorials/2-Variables.ipynb

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -271,11 +271,7 @@
271271
},
272272
"tags": []
273273
},
274-
"source": [
275-
"## More information\n",
276-
"\n",
277-
"The meshVariable code is described [**API docs** here.](https://underworldcode.github.io/underworld3/development_api/underworld3/discretisation.html#underworld3.discretisation.MeshVariable)"
278-
]
274+
"source": "## More information\n\nThe meshVariable code is described in the [API documentation](../../api/discretisation.md)."
279275
}
280276
],
281277
"metadata": {

docs/presentations/_quarto.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ format:
1717
href: https://github.com/underworldcode/underworld3
1818
- text: Documentation
1919
icon: book
20-
href: https://underworldcode.github.io/underworld3/
20+
href: https://underworld3.readthedocs.io/

0 commit comments

Comments
 (0)