Merge pull request #21

Fix issues with Docs and add to README.md

Author: 56kyle

.readthedocs.yml

@@ -0,0 +1,8 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.13"
+sphinx:
+  configuration: docs/conf.py

README.md

@@ -11,6 +11,9 @@ Any advice, support, PR's, etc. are welcome and would be greatly appreciated.
 
 As it stands this project is getting rather close to being ready, but not quite yet. Mainly I want to ensure the github actions pipeline is steady, but once that is done it should be alright for use.
 
+# Example Output
+For an example of this template's output, please visit the [demo](https://github.com/56kyle/robust-python-demo) which is kept up to date with the current state of this template.
+
 # Why does this project exist?
 
 Unfortunately, the [Hypermodern Python Cookiecutter] is no longer maintained nor modern.

docs/conf.py

@@ -123,7 +123,6 @@
 
 intersphinx_mapping = {
     "python": ("https://docs.python.org/3", None),
-    "pip": ("https://pip.pypa.io/en/stable/", None),
 }
 
 html_theme = "furo"

tests/constants.py

@@ -28,7 +28,7 @@
     "format-python",
     *TYPE_CHECK_NOX_SESSIONS,
     *TESTS_NOX_SESSIONS,
-    "docs-build",
+    "build-docs",
     "build-python",
     "build-container",
     "tox",

…_name}}/.github/workflows/docs-build.yml …_name}}/.github/workflows/build-docs.yml{{cookiecutter.project_name}}/.github/workflows/docs-build.yml renamed to {{cookiecutter.project_name}}/.github/workflows/build-docs.yml {{cookiecutter.project_name}}/.github/workflows/docs-build.yml renamed to {{cookiecutter.project_name}}/.github/workflows/build-docs.yml

@@ -1,19 +1,18 @@
-# .github/workflows/docs-build.yml
+# .github/workflows/build-docs.yml
 # See https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 
 name: Build Documentation
 
 on:
   pull_request:
     paths:
-      - "docs/**" # Documentation source files
-      - "src/**/*.py" # Code changes might impact API docs
+      - "docs/**"
+      - "src/**/*.py"
       - "noxfile.py"
       - "pyproject.toml"
-      - ".github/workflows/docs-build.yml"
-      # Include relevant config files that affect docs build
-      - ".ruff.toml" # Affects docstrings via linting
-      - "pyrightconfig.json" # Affects type hints in docs
+      - ".github/workflows/build-docs.yml"
+      - ".ruff.toml"  # Affects docstrings via linting
+      - "pyrightconfig.json"  # Affects type hints in docs
 
   push:
     branches:
@@ -24,7 +23,7 @@ on:
       - "src/**/*.py"
       - "noxfile.py"
       - "pyproject.toml"
-      - ".github/workflows/docs-build.yml"
+      - ".github/workflows/build-docs.yml"
 
   workflow_dispatch:
 
@@ -46,11 +45,10 @@ jobs:
           python-version-file: ".github/workflows/.python-version"
 
       - name: Build documentation
-        run: uvx nox -s docs-build
+        run: uvx nox -s build-docs
 
       - name: Upload documentation (HTML) Artifact
         uses: actions/upload-artifact@v4
         with:
           name: html-docs
           path: docs/_build/html/
-          retention-days: 5

{{cookiecutter.project_name}}/.readthedocs.yml

@@ -0,0 +1,8 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.13"
+sphinx:
+  configuration: docs/conf.py

{{cookiecutter.project_name}}/noxfile.py

@@ -171,7 +171,7 @@ def tests_rust(session: Session) -> None:
 
 
 {% endif -%}
-@nox.session(python=DEFAULT_PYTHON_VERSION, name="docs-build", tags=[DOCS, BUILD])
+@nox.session(python=DEFAULT_PYTHON_VERSION, name="build-docs", tags=[DOCS, BUILD])
 def docs_build(session: Session) -> None:
     """Build the project documentation (Sphinx)."""
     session.log("Installing documentation dependencies...")

{{cookiecutter.project_name}}/scripts/setup-remote.py

@@ -52,3 +52,7 @@ def get_parser() -> argparse.ArgumentParser:
     parser.add_argument("-u", "--user", dest="github_user", help="GitHub user name.")
     parser.add_argument("-n", "--name", dest="repo_name", help="Name of the repo.")
     return parser
+
+
+if __name__ == "__main__":
+    main()