Merge pull request #483 from Sohaibameer204/improve-docs-makefile

Remove docs/Makefile, update root Makefile for docs build, and update.

Author: drbenvincent

CONTRIBUTING.md

@@ -167,20 +167,19 @@ We recommend that your contribution complies with the following guidelines befor
 
 ## Building the documentation locally
 
-A local build of the docs is achieved by:
+To build the documentation, run from the **project root**:
 
 ```bash
-cd docs
 make html
 ```
-
-Sometimes not all changes are recognised. In that case run this (again from within the `docs` folder):
-
+To clean and rebuild the documentation from scratch:
 ```bash
-make clean && make html
+make cleandocs
+make html
 ```
+ Docs are built in docs/_build/html, but these docs are not committed to the GitHub repository due to .gitignore.
 
-Docs are built in `docs/_build`, but these docs are _not_ committed to the GitHub repository due to `.gitignore`.
+ 📌 Note: The previous docs/Makefile has been removed. Please use only the root-level Makefile for documentation commands
 
 ## Overview of code structure
 

Makefile

@@ -1,4 +1,4 @@
-.PHONY: init lint check_lint test
+.PHONY: init lint check_lint test uml html cleandocs
 
 init:
 	python -m pip install -e . --no-deps
@@ -20,3 +20,12 @@ test:
 
 uml:
 	pyreverse -o png causalpy --output-directory docs/source/_static --ignore tests
+
+# Docs build commands
+
+html:
+	sphinx-build -b html docs/source docs/_build
+
+cleandocs:
+	rm -rf docs/_build
+	rm -rf docs/source/api/generated