Added doctest to CI

.github/workflows/test_on_push.yml

@@ -7,6 +7,7 @@ on:
     branches:
     - main
 
+
 jobs:
   style:
     runs-on: ubuntu-latest
@@ -63,3 +64,29 @@ jobs:
         uses: codecov/[email protected]
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
+
+  run_doctests:
+    needs: style
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+    name: Doctests (ubuntu-latest / Python 3.11)
+
+    steps:
+      - name: Check out pybamm-cookiecutter repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        id: setup-python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+          cache: 'pip'
+
+      - name: Install nox
+        run: python -m pip install nox
+
+      - name: Check if the documentation can be built for GNU/Linux
+        run: python -m nox -s docs

README.md

@@ -22,9 +22,11 @@
 [pypi-version]:             https://img.shields.io/pypi/v/pybamm-cookiecutter
 [rtd-badge]:                https://readthedocs.org/projects/pybamm-cookiecutter/badge/?version=latest
 [rtd-link]:                 https://pybamm-cookiecutter.readthedocs.io/en/latest/?badge=latest -->
+
+<!-- SPHINX-START -->
 [![Powered by NumFOCUS](https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A)](http://numfocus.org)
 
-This repository contains a `cookiecutter` template for battery modeling projects using PyBaMM, released under the [BSD-3-Clause license](LICENSE). Currently under active development.
+This repository contains a `cookiecutter` template for battery modeling projects using PyBaMM, released under the [BSD-3-Clause license](https://github.com/pybamm-team/pybamm-cookiecutter/blob/main/LICENSE). Currently under active development.
 
 ## 📄 Using `pybamm-cookiecutter`
 
@@ -82,4 +84,5 @@ For any questions, comments, suggestions or bug reports, please see the
 
 ## 📃 License
 
-`pybamm-cookiecutter` is fully open source. For more information about its license, see [LICENSE](https://github.com/pybamm-team/pybamm-cookiecutter/blob/main/LICENSE.txt).
+`pybamm-cookiecutter` is fully open source. For more information about its license, see [LICENSE](https://github.com/pybamm-team/pybamm-cookiecutter/blob/main/LICENSE).
+<!-- SPHINX-END -->

docs/index.md

@@ -8,6 +8,7 @@
 
 ```{include} ../README.md
 :start-after: <!-- SPHINX-START -->
+:end-before: <!-- SPHINX-END -->
 ```
 
 ## Indices and tables

noxfile.py

@@ -13,7 +13,9 @@ def build_docs(session: nox.Session) -> None:
     """Build the documentation and load it in a browser tab, rebuilding on changes."""
     envbindir = session.bin
     session.install("-e", ".[docs]")
-    with session.chdir("docs/"):
+    session.chdir("docs/")
+    # For local development
+    if session.interactive:
         session.run(
             "sphinx-autobuild",
             "-j",
@@ -23,6 +25,17 @@ def build_docs(session: nox.Session) -> None:
             ".",
             f"{envbindir}/../tmp/html",
         )
+    # For CI testing if documentation builds
+    else:
+        session.run(
+            "sphinx-build",
+            "-b",
+            "html",
+            "-W",
+            "--keep-going",
+            ".",
+            f"{envbindir}/../tmp/html",
+        )
 
 @nox.session(name="test-generation")
 def run_template_generation(session):