Skip to content

Commit

Permalink
docs: more verbose packaging notes
Browse files Browse the repository at this point in the history
  • Loading branch information
jeffjennings committed Jul 10, 2024
1 parent 0994817 commit 5c21bfb
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/package.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: build and upload pip
name: build and release to PyPI

on:
release:
Expand Down Expand Up @@ -34,7 +34,7 @@ jobs:
- name: Build binary wheel and source tarball
run: |
python -m pep517.build --source --binary --out-dir dist/ .
- name: Publish distribution to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
with:
Expand Down
2 changes: 1 addition & 1 deletion docs/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/>`_.
| - `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`.
Expand Down

0 comments on commit 5c21bfb

Please sign in to comment.