NLeSC · fdiblen · Aug 21, 2024 · Aug 20, 2024 · Aug 20, 2024 · Aug 20, 2024
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,7 @@
 
 ### Added
 
+* Make online documentation optional [#476](https://github.com/NLeSC/python-template/pull/476)
 * Added Python 3.12 support [#356](https://github.com/NLeSC/python-template/issues/356)
 * Template unit tests for documentation generation, linting and version bumping
 * Docstring for function

diff --git a/copier.yml b/copier.yml
@@ -77,6 +77,12 @@ AddGitHubActions:
   default: "{{ template_profile != 'minimum' }}"
   help: GitHub actions to test the package and the documentation
 
+AddOnlineDocumentation:
+  when: "{{ template_profile == 'ask' }}"
+  type: bool
+  default: "{{ template_profile != 'minimum' }}"
+  help: Online documentation using Read the Docs
+
 
 # internal fields
 _subdirectory: template

diff --git a/...b/workflows/{% if AddOnlineDocumentation %}next_steps_online_documentation.yml{% endif %} b/...b/workflows/{% if AddOnlineDocumentation %}next_steps_online_documentation.yml{% endif %}
@@ -0,0 +1,29 @@
+on: [push]
+permissions:
+  contents: write
+  issues: write
+name: Create issues for next steps
-name: Create issues for next steps
+name: Create readthedocs issue for next steps
-name: Create issues for next steps
+name: Create readthedocs issue for next steps
+jobs:
+  next_steps:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Create readthedocs issue
+        uses: JasonEtco/create-an-issue@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          filename: .github/next_steps/03_readthedocs.md
+        id: readthedocs
+      - name: List created issues
+        run: |
+          echo 'Created issues that must be completed to have fully working Python package:
+          * Read the Docs instructions ${{ steps.readthedocs.outputs.url }}'
+      - name: Cleanup files needed to create next steps issues
+        run: |
+          git config --global user.name 'NLeSC Python template'
+          git config --global user.email '[email protected]'
+          git rm .github/workflows/next_steps_online_documentation.yml
+          git rm -r .github/next_steps
+          git commit -am "Cleanup automated next steps issue generator"
+          git push
diff --git a/template/.readthedocs.yaml → ...umentation %}.readthedocs.yaml{% endif %} b/template/.readthedocs.yaml → ...umentation %}.readthedocs.yaml{% endif %}