From ebcf17e730bda89fa405d7b1a44228a075592e20 Mon Sep 17 00:00:00 2001 From: Jeff Jennings Date: Wed, 26 Jun 2024 12:31:59 -0400 Subject: [PATCH] docs: add note on deploying docs in new repos --- docs/getting_started.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 080fe4a..ba4c894 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -26,7 +26,9 @@ Making a new Python repo using `py_template` -------------------------------------------- | 1) Click the 'Use this template' button at the top-right of the GitHub page. | 2) In your new repo, rename (search and replace) all instances of "py_template" with the name for your package. -| 3) Update the `authors` field in `pyproject.toml`, `docs/conf.py` and `LICENSE.rst` (the template is partially based on the `OpenAstronomy packaging guide `_, so please retain that aspect of the license). +| 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` +| 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` +| 4) Update the `authors` field in `pyproject.toml`, `docs/conf.py` and `LICENSE.rst` (the template is partially based on the `OpenAstronomy packaging guide `_, so please retain that aspect of the license). Interacting with your new code ------------------------------