Skip to content

Commit d3b0e54

Browse files
committed
docs: update getting started guide
1 parent 395dc13 commit d3b0e54

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/getting_started.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@ Getting started
33

44
Repo file structure
55
-------------------
6-
| The `py_template` repo has a common file structure:
6+
| The `py_template` repo has a basic file structure:
77
| 1) `.github` has two subfolders:
88
| * `ISSUE_TEMPLATE` has files that are templates users can select from when opening an issue in the repo on GitHub
99
| * `workflows` implements continuous integration (CI) through GitHub 'actions' that are automatically run according to a chosen trigger. These are currently:
1010
| - `docs.yml` builds and deploys this docs site when a push is made to `main`.
1111
| - `format_lint.yml` lints and formats the code on each push using *ruff* and *black*.
12+
| - `package.yml` releases the package to PyPI on each *tagged* push to `main`. This makes the latest tagged version of the package `pip`-installable.
1213
| - `tests.yml` runs tests with *pytest* on each push.
1314
| - `type_check.yml` runs type checking with *mypy* on each push. The CI continues even if the type checker finds errors.
1415
| 2) `docs` has the files used to build the docs with *Sphinx*, with the site content in `index.rst` and `py_API.rst`.
@@ -19,7 +20,7 @@ Repo file structure
1920
| 7) `LICENSE.rst` has the package's license.
2021
| 8) `MANIFEST.in` has instructions for how to pre-process the package (which files to exclude) when preparing to release it to PyPI (the Python Package Index). Packages uploaded to PyPI can be installed by users with *pip*.
2122
| 9) `README.md` is the file you're reading! It has badges that use the CI to display if the unit tests are passing, what percentage of the code is covered by the tests, and if the docs build and deploy is passing.
22-
| 10) `pyproject.toml` is the configuration file for the entire package. See the `Python docs <https://packaging.python.org/en/latest/guides/writing-pyproject-toml/>`_ for a description of its contents.
23+
| 10) `pyproject.toml` is the configuration file for packaging the software. See the `Python docs <https://packaging.python.org/en/latest/guides/writing-pyproject-toml/>`_ for a description of its contents. See also the `example_setup_files` directory for an example minimal `pyproject.toml` and the analogous `setup.py`.
2324
2425
Making a new Python repo using `py_template`
2526
--------------------------------------------

0 commit comments

Comments
 (0)