Merge pull request #97 from baagaard-usgs/docs-component-implementations

Add list of available component implementations to manual

Author: baagaard-usgs

CHANGES.md

@@ -1,3 +1,8 @@
+## Version 3.1.2 (2024/06/17)
+
+* **Fixed**
+  * Include list of available components in manual.
+
 ## Version 3.1.1 (2024/06/04)
 
 * **Fixed**

docs/Makefile.am

@@ -34,8 +34,9 @@ dist_noinst_DATA = \
 	user/file-formats/time-history.md \
 	user/file-formats/simple-ascii.md \
 	user/timedb/index.md \
-	user/components/update.sh \
+	user/components/update_components.sh \
 	user/components/index.md \
+	user/components/implementations.md \
 	user/components/utils/PointsStream.md \
 	user/components/utils/UnitTestApp.md \
 	user/components/utils/index.md \

docs/developer/index.md

@@ -6,7 +6,7 @@
 Placeholder for developer guide.
 :::
 
-:::{toctree}
-contributing.md
-testing.md
-:::
+%:::{toctree}
+%contributing.md
+%testing.md
+%:::

docs/user/components/implementations.md

@@ -0,0 +1,48 @@
+# Component Implementations
+
+## Coordinate systems
+
+[`CSCart`](geocoords/CSCart.md)
+: Cartesian coordinate system.
+
+[`CSGeo`](geocoords/CSGeo.md)
+: Geographic coordinate system supported by Proj.
+
+[`CSGeoLocal`](geocoords/CSGeoLocal.md)
+: Geographic coordinate system with local origin and rotation angle.
+
+## Spatial databases
+
+[`AnalyticDB`](spatialdb/AnalyticDB.md)
+: Spatial database with values specified by analytical functions.
+
+[`UniformDB`](spatialdb/UniformDB.md)
+: Spatial database with uniform values (no spatial variation).
+
+[`SimpleDB`](spatialdb/SimpleDB.md)
+: Spatial database with arbitrarily distributed points.
+
+[`SimpleGridDB`](spatialdb/SimpleGridDB.md)
+: Spatial database with points on a logically rectangular grid aligned with the coordinate axes.
+
+[`CompositeDB`](spatialdb/CompositeDB.md)
+: Spatial database comprised of two spatial databases.
+
+[`UserFunctionDB`](spatialdb/UserFunctionDB.md)
+: Spatial database with values specified by a C/C++ function (used in MMS tests).
+
+[`GravityField`](spatialdb/GravityField.md)
+: Special spatial database implementation for a gravity field.
+
+## Temporal databasses
+
+[`TimeHistory`](spatialdb/TimeHistory.md)
+: User-specified time history using a file.
+
+## Nondimensionalization
+
+[`NondimElasticQuasistatic`](units/NondimElasticQuasistatic.md)
+: Nondimensional length scales in terms of quasistatic parameters.
+
+[`NondimElasticDynamic`](units/NondimElasticDynamic.md)
+: Nondimensional length scales in terms of dynamic parameters.

docs/user/components/index.md

@@ -7,6 +7,7 @@
 ---
 maxdepth: 2
 ---
+implementations.md
 geocoords/index.md
 spatialdb/index.md
 spatialdb/generator/index.md

docs/user/components/update.sh

@@ -0,0 +1,2 @@
+~/src/cig/pythia/bin/pyre_doc_components.py --package=SpatialData --src-path=$PYENV/pylith-debug/lib/python3.12/site-packages/spatialdata --output-path=./ --manual-toc=toc.json
+cat index.md | sed -e "s#apps/index.md#implementations.md\\napps/index.md#g" > tmp.md && mv -f tmp.md index.md