Merge pull request #181 from BrianPugh/BrianPugh-patch-1

Check for warnings in building docs

.github/workflows/tests.yaml

@@ -121,4 +121,4 @@ jobs:
       - name: Build HTML docs
         run: |
           source ${{ env.ACTIVATE_PYTHON_VENV }}
-          sphinx-build -b html docs/source/ docs/build/html
+          sphinx-build -b html -W docs/source/ docs/build/html

bootstrap

@@ -235,6 +235,7 @@ def main():
 
     replacements: dict[str, str] = {
         "CURRENT_YEAR_HERE": str(date.today().year),
+        "README_TEMPLATE": "README",
     }
 
     git_remote_url = git("config", "--get", "remote.origin.url").decode().strip()
@@ -379,6 +380,7 @@ def main():
     files.extend(REPO.rglob("*.md"))
     files.append(Path("pyproject.toml"))
     files.append(Path(".gitignore"))
+    files.append(Path("docs/source/index.rst"))
 
     if not is_library:
         files.append(Path("Dockerfile"))

docs/source/index.rst

@@ -1,7 +1,7 @@
 Welcome to pythontemplate's documentation!
 ==========================================
 
-.. include:: ../../README.rst
+.. include:: ../../README_TEMPLATE.rst
   :start-after: inclusion-marker-do-not-remove
 
 .. toctree::