diff --git a/Makefile b/Makefile index 373a4eb..236f5a8 100644 --- a/Makefile +++ b/Makefile @@ -39,3 +39,5 @@ linkcheck: @echo @echo "Check finished. Report is in $(LINKCHECKDIR)." +livehtml: + sphinx-autobuild "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) --ignore docs/_static/course_switcher.json --ignore docs/timetable/timetable.rst \ No newline at end of file diff --git a/README.md b/README.md index e8f0844..41250b6 100644 --- a/README.md +++ b/README.md @@ -28,7 +28,7 @@ The steps can be outlined like this: 2. Install the requirements: - python3 -m pip install -r requirements.txt + python3 -m pip install -r requirements.txt sphinx-autobuild # currently there is a blocking dependency on some of the # packages listed in requirements.txt, however, since pip # will allow updating a package that breaks compatibility, we @@ -37,19 +37,25 @@ The steps can be outlined like this: # :fingers_crossed: python3 -m pip install -U "sphinx>=7.2.5" -3. Build documentation +3. Development server + + make livehtml + + This will open a local webserver that auto-reloads whenever you make + changes to the `rst` documentation or any files in the `docs/` directory. + +4. Build documentation make Now the documentation is build and can be found in `build/html`. -4. Open the documentation: +5. Open the documentation: firefox build/html/index.html And you should be ready to see the just build documentation. - Running Locally in Podman ------------------------- diff --git a/requirements.txt b/requirements.txt index 4173564..75fa49a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -18,4 +18,4 @@ sphinx-design sphinxcontrib-jquery # yaml -pyyaml +pyyaml \ No newline at end of file