Update docs [skip ci]

CCA-Software-Group · Jun 26, 2024 · 4f7cd9c · 4f7cd9c
1 parent 3f1409e
commit 4f7cd9c
Show file tree

Hide file tree

Showing 7 changed files with 15 additions and 11 deletions.
diff --git a/_sources/getting_started.rst.txt b/_sources/getting_started.rst.txt
@@ -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 <https://github.com/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 <https://github.com/OpenAstronomy/packaging-guide>`_, so please retain that aspect of the license).
 
 Interacting with your new code
 ------------------------------

diff --git a/coverage/class_index.html b/coverage/class_index.html
@@ -55,7 +55,7 @@ <h2>
         </h2>
         <p class="text">
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-06-26 15:13 +0000
+            created at 2024-06-26 16:32 +0000
         </p>
     </div>
 </header>
@@ -108,7 +108,7 @@ <h2>
     <div class="content">
         <p>
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-06-26 15:13 +0000
+            created at 2024-06-26 16:32 +0000
         </p>
     </div>
     <aside class="hidden">

diff --git a/coverage/function_index.html b/coverage/function_index.html
@@ -55,7 +55,7 @@ <h2>
         </h2>
         <p class="text">
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-06-26 15:13 +0000
+            created at 2024-06-26 16:32 +0000
         </p>
     </div>
 </header>
@@ -124,7 +124,7 @@ <h2>
     <div class="content">
         <p>
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-06-26 15:13 +0000
+            created at 2024-06-26 16:32 +0000
         </p>
     </div>
     <aside class="hidden">

diff --git a/coverage/index.html b/coverage/index.html
@@ -54,7 +54,7 @@ <h2>
         </h2>
         <p class="text">
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-06-26 15:13 +0000
+            created at 2024-06-26 16:32 +0000
         </p>
     </div>
 </header>
@@ -96,7 +96,7 @@ <h2>
     <div class="content">
         <p>
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-06-26 15:13 +0000
+            created at 2024-06-26 16:32 +0000
         </p>
     </div>
     <aside class="hidden">

diff --git a/coverage/z_e6f4b5fa949e942d_example_module_py.html b/coverage/z_e6f4b5fa949e942d_example_module_py.html
@@ -65,7 +65,7 @@ <h2>
             <a id="nextFileLink" class="nav" href="index.html">&#xbb; next</a>
             &nbsp; &nbsp; &nbsp;
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-06-26 15:13 +0000
+            created at 2024-06-26 16:32 +0000
         </p>
         <aside class="hidden">
             <button type="button" class="button_next_chunk" data-shortcut="j"></button>
@@ -139,7 +139,7 @@ <h2>
             <a class="nav" href="index.html">&#xbb; next</a>
             &nbsp; &nbsp; &nbsp;
             <a class="nav" href="https://coverage.readthedocs.io/en/7.5.4">coverage.py v7.5.4</a>,
-            created at 2024-06-26 15:13 +0000
+            created at 2024-06-26 16:32 +0000
         </p>
     </div>
 </footer>

diff --git a/getting_started.html b/getting_started.html
@@ -123,7 +123,9 @@ <h2>Making a new Python repo using <code class="xref py py-obj docutils literal
 <div class="line-block">
 <div class="line">1) Click the ‘Use this template’ button at the top-right of the GitHub page.</div>
 <div class="line">2) In your new repo, rename (search and replace) all instances of “py_template” with the name for your package.</div>
-<div class="line">3) Update the <code class="xref py py-obj docutils literal notranslate"><span class="pre">authors</span></code> field in <code class="xref py py-obj docutils literal notranslate"><span class="pre">pyproject.toml</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">docs/conf.py</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">LICENSE.rst</span></code> (the template is partially based on the <a class="reference external" href="https://github.com/OpenAstronomy/packaging-guide">OpenAstronomy packaging guide</a>, so please retain that aspect of the license).</div>
+<div class="line">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 <code class="xref py py-obj docutils literal notranslate"><span class="pre">github/workflows/docs.yml</span></code></div>
+<div class="line">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 <code class="xref py py-obj docutils literal notranslate"><span class="pre">github/workflows/docs.yml</span></code></div>
+<div class="line">4) Update the <code class="xref py py-obj docutils literal notranslate"><span class="pre">authors</span></code> field in <code class="xref py py-obj docutils literal notranslate"><span class="pre">pyproject.toml</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">docs/conf.py</span></code> and <code class="xref py py-obj docutils literal notranslate"><span class="pre">LICENSE.rst</span></code> (the template is partially based on the <a class="reference external" href="https://github.com/OpenAstronomy/packaging-guide">OpenAstronomy packaging guide</a>, so please retain that aspect of the license).</div>
 </div>
 </section>
 <section id="interacting-with-your-new-code">

diff --git a/searchindex.js b/searchindex.js