added links to documentation

keithalegrand · keithalegrand · commit ae83e5f6e48c · 2025-05-27T15:56:13.000+01:00
diff --git a/README.md b/README.md
@@ -121,3 +121,7 @@ J. Kulik and K.A. LeGrand, “Nonlinearity and Uncertainty Informed Moment-Match
 }
 
 ```
+
+## Documentation
+
+For more information about PyEst, please see the [documentation](https://pyest.readthedocs.io/en/latest/).
diff --git a/docs/api.rst b/docs/api.rst
@@ -37,6 +37,14 @@ Metrics
 -------
 
 .. automodule:: pyest.metrics
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Sensors
+-------
+
+.. automodule:: pyest.sensors
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/index.rst b/docs/index.rst
@@ -23,6 +23,7 @@ PyEst is a Python package for adaptive Gaussian mixture state estimation.
    examples
    contributing
 
+PyEst source code is available at `GitHub <https://github.com/scope-lab/pyest>`_
 Indices and tables
 ==================
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -29,7 +29,7 @@ license-files = ["LICEN[CS]E*"]
 [project.urls]
 Homepage = "https://github.com/scope-lab/pyest"
 Issues = "https://github.com/scope-lab/pyest"
-Documentation = "https://github.com/scope-lab/pyest"
+Documentation = "https://pyest.readthedocs.io/en/latest/"
 
 [project.optional-dependencies]
 test = [
@@ -47,4 +47,4 @@ examples = [
 source = "vcs"
 
 [tool.hatch.version.raw-options]
-version_scheme = "no-guess-dev"
+version_scheme = "no-guess-dev"

Original file line number	Diff line number	Diff line change
`@@ -121,3 +121,7 @@ J. Kulik and K.A. LeGrand, “Nonlinearity and Uncertainty Informed Moment-Match`
`121`	`121`	`}`
`122`	`122`
`123`	`123`	```
	`124`	`+`
	`125`	`+## Documentation`
	`126`	`+`
	`127`	`+For more information about PyEst, please see the [documentation](https://pyest.readthedocs.io/en/latest/).`