Skip to content

Commit 640d770

Browse files
committed
docs: rephrasing
1 parent d3b0e54 commit 640d770

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,4 +7,4 @@ Template Python repository
77

88
This is a basic template for a Python repository, with the components needed to develop and release an open source software package. These include unit tests; type annotations; a documentation site with an API; and continuous integration for tests, code coverage, linting/formatting, type checking, publishing the docs, and releasing the software as a `pip`-installable package.
99

10-
See the [docs](https://cca-software-group.github.io/py_template/) for a 'Getting Started' guide with a description of the repo's contents, steps on how to make your own Python repo using this template, and what to do next to build your own package.
10+
See the [docs](https://cca-software-group.github.io/py_template/) for a 'Getting Started' guide with a description of the repo's contents, steps on how to make your own Python repo using this template, and what to do next to develop your package.

docs/getting_started.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Making a new Python repo using `py_template`
2727
| 1) Click the 'Use this template' button at the top-right of the GitHub page.
2828
| 2) In your new repo, rename (search and replace) all instances of "py_template" with the name for your package.
2929
| 3a) If you create a public repo, to set up your docs deployment CI: from your repo page, go to 'Settings' then 'Pages', then set 'Source' as 'Deploy from a branch' and set 'Branch' as 'gh-pages'. Your docs will now deploy according to the trigger in `.github/workflows/docs.yml`
30-
| 3b) If you create a private repo, the docs build will fail because private repos can't have a public docs page. You can disable the docs build and deploy workflows in `.github/workflows/docs.yml`
30+
| 3b) If you create a private repo, the docs build will fail because private repos can't have a public docs page. You can disable the docs build and deploy workflow in `.github/workflows/docs.yml`
3131
| 4) Update the `authors` field in `pyproject.toml`, `docs/conf.py` and `LICENSE.rst` (the template is partially based on the `OpenAstronomy packaging guide <https://github.com/OpenAstronomy/packaging-guide>`_, so please retain that aspect of the license).
3232
3333
Interacting with your new code

0 commit comments

Comments
 (0)