Minor Fixes

Author: richarddushime

.github/workflows/cookiecutter_docs.yml renamed to .github/workflows/deployment_workflow.yml

@@ -1,4 +1,4 @@
-name: Documentation
+name: Deployment Workflow
 on:
   push:
     branches:

docs/source/conf.py

@@ -1,8 +1,19 @@
 # conf.py
 # Configuration file for the Sphinx documentation builder.
+import setuptools_scm
+
+
 project = "python-cookiecutter"
 copyright = "2025, University College London"
 author = "Neuroinformatics Unit"
+try:
+    full_version = setuptools_scm.get_version(root="../..", relative_to=__file__)
+    # Splitting the release on '+' to remove the commit hash
+    release = full_version.split('+', 1)[0]
+except LookupError:
+    # if git is not initialised, still allow local build
+    # with a dummy version
+    release = "0.0.0"
 
 # -- General configuration ---------------------------------------------------
 extensions = [
@@ -73,7 +84,7 @@
         },
     ],
     "logo": {
-        "text": f"{project}",
+        "text": f"{project} v{release}",
     },
     "footer_start": ["footer_start"],
     "footer_end": ["footer_end"],
@@ -107,7 +118,7 @@ def setup(app):
 
     <p>Sorry, we couldn't find that page.</p>
 
-    <p>We occasionally restructure the cookiecutter website, and some links may have broken.</p> 
+    <p>We occasionally restructure the python-cookiecutter website, and some links may have broken.</p> 
 
     <p>Try using the search box or go to the homepage.</p>
 """,

docs/source/infrastructure.md

@@ -1,6 +1,53 @@
 # Infrastructure
 
-## Pre-commit hooks
+## Tests
+
+Write your test methods and classes in the `test` folder. We are using [pytest](https://docs.pytest.org/en/7.2.x/getting-started.html).
+In your test module you can call your methods in a simple way:
+
+```python
+# filename: test_math.py
+from my_awesome_software import math
+
+# here your test function
+```
+
+If you're testing a small piece of code, make it a unit test. If you want to test whether two or more software units work well together, create an integration test.
+
+:::{important}
+Before committing your changes
+:::
+
+### Run the tests
+
+Be sure that you have installed pytest and run it
+```bash
+pip install pytest
+pytest
+```
+You should also see coverage information.
+
+### Install your package locally
+
+For a local, editable install, in the project directory, run:
+```bash
+pip install -e .
+```
+
+For a local, editable install with all the development tools (e.g. testing, formatting etc.) run:
+```bash
+pip install -e '.[dev]'
+```
+
+You might want to install your package in an _ad hoc_ environment.
+
+To test if the installation works, try to call your modules with python in another folder from the same environment.
+```python
+from my_awesome_sofware.math import add_two_integers
+add_two_integers(1, 2)
+```
+
+# Pre-commit hooks
 
 Running `pre-commit install` will set up [pre-commit hooks](https://pre-commit.com/) to ensure the code is
 formatted correctly. Currently, these are:

docs/source/project_setup.md

@@ -174,7 +174,7 @@ git push --set-upstream origin main
 ```
 That\'s it! Your project is now set up and ready to go. 🚀
 
-# Modules and Tests
+# Modules
 
 Your methods and classes would live inside the folder `my_awesome_software`. Split the functionalities into modules, and save them as `.py` files, e.g.:
 ```
@@ -204,48 +204,3 @@ the `[project]` heading:
 ```toml
 dependencies = ["numpy", "pandas"]
 ```
-
-## Write tests
-
-Write your test methods and classes in the `test` folder. We are using [pytest](https://docs.pytest.org/en/7.2.x/getting-started.html).
-In your test module you can call your methods in a simple way:
-```python
-# filename: test_math.py
-from my_awesome_software import math
-
-# here your test function
-```
-
-If you're testing a small piece of code, make it a unit test. If you want to test whether two or more software units work well together, create an integration test.
-
-:::{important}
-Before committing your changes
-:::
-### Run the tests
-
-Be sure that you have installed pytest and run it
-```bash
-pip install pytest
-pytest
-```
-You should also see coverage information.
-
-### Install your package locally
-
-For a local, editable install, in the project directory, run:
-```bash
-pip install -e .
-```
-
-For a local, editable install with all the development tools (e.g. testing, formatting etc.) run:
-```bash
-pip install -e '.[dev]'
-```
-
-You might want to install your package in an _ad hoc_ environment.
-
-To test if the installation works, try to call your modules with python in another folder from the same environment.
-```python
-from my_awesome_sofware.math import add_two_integers
-add_two_integers(1, 2)
-```