Add new docs dependency: sphinx-autobuild. Add livehtml cmd in makefile. Update documentation with new contribution instructions for building documentation. (#31)

- Add new docs dependency: sphinx-autobuild
- Add livehtml cmd to makefile
- Update documentation with new contribution instructions for building documentation.

Author: fkdosilovic

docs/Makefile

@@ -18,3 +18,6 @@ help:
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
 %: Makefile
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+livehtml:
+	uv run sphinx-autobuild -b dirhtml --pre-build "rm -rf $(BUILDDIR)" "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/source/conf.py

@@ -69,7 +69,7 @@
     },
     "awesome_external_links": True,
     "main_nav_links": {
-        "Home": "https://judge0.github.io/judge0-python/",
+        "Home": "index",
         "Judge0": "https://judge0.com/",
     },
 }

docs/source/contributors_guide/contributing.rst

@@ -39,22 +39,21 @@ Preparing the development setup
 Building documentation
 ----------------------
 
-Documentation is built using Sphinx. To build the documentation, run the
+Documentation is built using Sphinx. While working on a documentation, you can run
 
 .. code-block:: console
 
     $ cd docs
-    $ make html
+    $ make livehtml
 
-You should inspect the changes in the documentation by opening the
-``docs/build/html/index.html`` file in your browser.
+The ``make livehtml`` command will start a live HTTP server, watch the `docs` directory for changes,
+and rebuild the documentation on every change, enabling you to continuously work on the documentation,
+without having to manually rebuild it after every change.
 
-.. note::
-    If you are having trouble with the documentation and are seeing unexpected
-    output, delete the ``docs/build`` directory and rerun the ``make html`` command.
+You can inspect the changes by opening the ``http://localhost:8000`` in your browser.
 
-You'll see a different output since the documentation is build with
-`sphinx-multiversion <https://github.com/sphinx-contrib/multiversion>`_ extension.
+.. You'll see a different output since the documentation is build with
+.. `sphinx-multiversion <https://github.com/sphinx-contrib/multiversion>`_ extension.
 
 Testing
 -------

pyproject.toml

@@ -48,6 +48,7 @@ docs = [
     "sphinxawesome-theme==5.3.2",
     "sphinx-autodoc-typehints==2.3.0",
     "sphinx-multiversion==0.2.4",
+    "sphinx-autobuild>=2024.10.3",
 ]
 dev = [{ include-group = "test" }, { include-group = "docs" }]