diff --git a/_sources/getting_started.rst.txt b/_sources/getting_started.rst.txt index eb93495..4717a99 100644 --- a/_sources/getting_started.rst.txt +++ b/_sources/getting_started.rst.txt @@ -9,7 +9,7 @@ Repo file structure | * `workflows` implements continuous integration (CI) through GitHub 'actions' that are automatically run according to a chosen trigger. These are currently: | - `docs.yml` builds and deploys this docs site when a push is made to `main`. | - `format_lint.yml` lints and formats the code on each push using *ruff* and *black*. -| - `package.yml` releases the package to PyPI on each *tagged* push to `main`. This makes the latest tagged version of the package `pip`-installable. +| - `package.yml` releases the package to PyPI on each *release* (create a release from the repo's main GitHub page). This makes the latest release version of the package *pip*-installable. For a guide on how to first reserve a name for your project on PyPI (necessary for this workflow), see the `Python packaging guide `_. | - `tests.yml` runs tests with *pytest* on each push. | - `type_check.yml` runs type checking with *mypy* on each push. The CI continues even if the type checker finds errors. | 2) `docs` has the files used to build the docs with *Sphinx*, with the site content in `index.rst` and `py_API.rst`. diff --git a/coverage/class_index.html b/coverage/class_index.html index 3e7f0a8..faffb1e 100644 --- a/coverage/class_index.html +++ b/coverage/class_index.html @@ -55,7 +55,7 @@

coverage.py v7.5.4, - created at 2024-07-10 16:25 +0000 + created at 2024-07-10 16:36 +0000

@@ -108,7 +108,7 @@

coverage.py v7.5.4, - created at 2024-07-10 16:25 +0000 + created at 2024-07-10 16:36 +0000