Merge pull request #65 from geodynamics/baagaard/docs-cleanup

Small clean up of documentation

Author: baagaard-usgs

CHANGES.md

@@ -1,3 +1,11 @@
+## Version 3.0.0 (2022/06/06)
+
+* Convert to Python 3
+* Change `label` in `SpatialDB` and `TimeHistory` to `description` to avoid confusion with other Pyre properties called `label`.
+* Create online documentation for Spatial Data that is now separate from PyLith.
+  * Documentation covers more features and use cases.
+  * Examples include C++, Python, and `cfg` files.
+
 ## Version 2.0.0 (2021/01/09)
 
 * Update to use Proj 6.x. This allows a user to specify a coordinate

Makefile.am

@@ -33,8 +33,8 @@ DISTCHECK_CONFIGURE_FLAGS = \
 	LDFLAGS="-L${PROJ4_LIBDIR} -L${CPPUNIT_LIBDIR} -L${CIG_LIBDIR}"
 
 EXTRA_DIST = \
-	CHANGES \
-        LICENSE.md \
+	CHANGES.md \
+    LICENSE.md \
 	docker/spatialdata-testenv \
 	ci-config/run_tests.sh \
 	ci-config/codecov.yml

README.md

@@ -22,7 +22,7 @@ discretization.
 
 * GNU build tools w/C++ and C compilers
 * Proj cartographic projections library (v6.0 or later) (http://proj.maptools.org)
-* [Optional] Pyre 0.8 and NumPy
+* [Optional] Pyre 1.0 and NumPy
 * [Optional] CppUnit (for unit testing)
 
 ## Author

docs/developer/index.md

@@ -1,5 +1,11 @@
 # Developer Guide
 
+:::{admonition} Under construction.
+:class: warning
+
+Placeholder for developer guide.
+:::
+
 :::{toctree}
 contributing.md
 testing.md

docs/intro/development-plan.md

@@ -1,11 +1,7 @@
 # Development Plan
 
-## Version 3.0.0dev
+## Version 3.x.xdev
 
 List of new features currently available in the `main` branch.
 
-* Convert to Python 3
-* Change `label` in `SpatialDB` and `TimeHistory` to `description` to avoid confusion with other Pyre properties called `label`.
-* Create online documentation for Spatial Data that is now separate from PyLith.
-  * Documentation covers more features and use cases.
-  * Examples include C++, Python, and `cfg` files.
+No new features.

setup.cfg

@@ -7,7 +7,7 @@ name = spatialdata
 version = 3.0.0
 author = Brad Aagaard
 author_email = baagaard@usgs.gov
-description = :TODO:
+description = Library for specifying spatial variations in input parameters (used in PyLith).
 license = MIT
 url = http://www.geodynamics.org/cig/software/spatialdata