Update README.md files and __init__.py documentation

Author: ChrisMayfield

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `assert_not_imported` can also take a string
 - `redirect_stdin` also wraps `builtins.input`
+- various docstrings and README.md file contents
 
 
 ## [1.4.0] - 2025-10-09

README.md

@@ -18,7 +18,7 @@ To build `autograder.zip`, run this command from an assignment's directory:
 
 ## Documentation
 
-See the [examples](examples) directory for documentation and test assignments.
+To get started, read the [examples](examples) directory and [API documentation](https://jmu-cs.github.io/jmu_pytest_utils/).
 
 See the [CHANGELOG](CHANGELOG.md) for release notes and recently added features.
 

examples/README.md

@@ -12,28 +12,9 @@ The following "assignments" are used for testing `jmu_pytest_utils` and provided
 * [8_test_coverage](8_test_coverage) -- grading student's tests
 * [9_leaderboard](9_leaderboard) -- Gradescope leaderboard
 
-
 ## API Docs
 
-Please refer to the docstrings in the files below.
-
-Most tests will import the following two modules:
-
-* [`jmu_pytest_utils.common`](../jmu_pytest_utils/common.py)
-* [`jmu_pytest_utils.decorators`](../jmu_pytest_utils/decorators.py)
-
-Tests that analyze the student's *code* import:
-
-* [`jmu_pytest_utils.audit`](../jmu_pytest_utils/audit.py)
-
-Tests that analyze the student's *tests* import:
-
-* [`jmu_pytest_utils.coverage`](../jmu_pytest_utils/coverage.py)
-
-And of course, you might also import pytest:
-
-* [API Reference - pytest documentation](https://docs.pytest.org/en/stable/reference/reference.html)
-
+The [API documentation](https://jmu-cs.github.io/jmu_pytest_utils/) is automatically built with [pdoc](https://pdoc.dev/) whenever there are new commits on the main branch.
 
 ## Configuration
 

jmu_pytest_utils/__init__.py

@@ -1,4 +1,29 @@
 """A pytest plugin for building and running Gradescope autograders.
 
 Source: https://github.com/JMU-CS/jmu_pytest_utils/
+
+## Modules to Import
+
+Most tests will import:
+
+* `jmu_pytest_utils.common` – style checking and I/O support
+* `jmu_pytest_utils.decorators` – `@required` and `@weight`
+
+Some tests will import:
+
+* `jmu_pytest_utils.audit` – analyze the student's source code
+* `jmu_pytest_utils.coverage` – analyze the student's unit tests
+* `jmu_pytest_utils.meta` – analyze the submission metadata
+
+And of course `pytest`:
+
+* [API Reference - pytest documentation](https://docs.pytest.org/en/stable/reference/reference.html)
+
+## Command-Line Tools
+
+Tests don't need to import:
+
+* `jmu_pytest_utils.builder` – autograder.zip build script
+* `jmu_pytest_utils.limit` – enforce the submission limit
+* `jmu_pytest_utils.plugin` – pytest plugin for results.json
 """