Skip to content

Commit 4f8472d

Browse files
committed
docs: enable livereload for mkdocs server in documentation setup
1 parent f8eb9f3 commit 4f8472d

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,7 @@ To build the documentation, run the following command:
364364
pip install -r ./requirements/requirements.docs.txt
365365

366366
# Serve documentation locally (for development):
367-
mkdocs serve -a 0.0.0.0:8000
367+
mkdocs serve -a 0.0.0.0:8000 --livereload
368368
# Or use the docs script:
369369
./scripts/docs.sh
370370

docs/dev/docs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To build the documentation, run the following command:
1111
pip install -r ./requirements/requirements.docs.txt
1212

1313
# Serve documentation locally (for development):
14-
mkdocs serve
14+
mkdocs serve -a 0.0.0.0:8000 --livereload
1515
# Or use the docs script:
1616
./scripts/docs.sh
1717

scripts/docs.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ main()
111111
else
112112
echo "[INFO]: Starting documentation server..."
113113
#shellcheck disable=SC2086
114-
mkdocs serve -a 0.0.0.0:${DOCS_PORT:-8000}
114+
mkdocs serve -a 0.0.0.0:${DOCS_PORT:-8000} --livereload
115115
# mike serve -a 0.0.0.0:${DOCS_PORT:-8000}
116116
fi
117117
echo "[OK]: Done."

0 commit comments

Comments
 (0)