Add Makefile and instructions to build the docs locally

Author: tdruez

Makefile

@@ -0,0 +1,19 @@
+# Python version can be specified with `$ PYTHON_EXE=python3.x make ...`
+PYTHON_EXE?=python3
+VENV_LOCATION=venv
+ACTIVATE?=. ${VENV_LOCATION}/bin/activate;
+
+conf:
+	@echo "-> Install dependencies"
+	./configure --docs
+
+docs: conf
+	rm -rf docs/build/
+	@${ACTIVATE} sphinx-build docs/source docs/build/
+
+clean:
+	@echo "-> Clean the Python env"
+	rm -rf .venv/ .*cache/ *.egg-info/ build/ dist/
+	find . -type f -name '*.py[co]' -delete -o -type d -name __pycache__ -delete
+
+.PHONY: conf docs clean

README.md

@@ -17,17 +17,22 @@ is vulnerable should be a problem of the past such that everyone can safely
 consume more free and open source software. We support not only open source
 software, but also open data, generated and curated by our applications.
 
-> **_NOTE:_** This is a repository with information on aboutcode open source
+> [!NOTE]
+> This is a repository with information on aboutcode open source
 > activities and not the actual code repository. See the
 > [projects section](https://github.com/aboutcode-org/aboutcode#projects) below
 > for links to all the code repositories of our projects with a brief overview
 > and our [wiki](https://github.com/aboutcode-org/aboutcode/wiki) if you are
 > looking to participate.
 
-### Documentation Build Status
+### Documentation Build
 
 ![Doc Build](https://github.com/aboutcode-org/aboutcode/actions/workflows/docs-ci.yml/badge.svg)
 
+> [!NOTE]
+> To manually build the documentation, run the `$ make docs` command from 
+> the root of this repo.
+
 ### Important Links
 
 Our homepage is at http://aboutcode.org

setup.cfg

@@ -28,22 +28,17 @@ license_files =
 
 [options]
 zip_safe = false
-
 setup_requires = setuptools_scm[toml] >= 4
-
 python_requires = >=3.7
-
 install_requires =
 
 
 [options.extras_require]
-
 docs =
-    Sphinx == 5.1.0
-    sphinx-rtd-theme >= 0.5.0
-    sphinx-reredirects >= 0.1.2
-    doc8 >= 0.8.1
+    Sphinx
+    sphinx-rtd-theme
+    sphinx-reredirects
+    doc8
     sphinx-autobuild
-    sphinx-rtd-dark-mode>=1.3.0
+    sphinx-rtd-dark-mode
     sphinx-copybutton
-