Using the vyos-documentation Docker container currently available through DockerHub returns the following error:
docker run --rm -it -p 8000:8000 -v "$(pwd)":/vyos -w /vyos/docs \
-e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) \
vyos/vyos-documentation make livehtml
Unable to find image 'vyos/vyos-documentation:latest' locally
latest: Pulling from vyos/vyos-documentation
e455cf41eadb: Pull complete
322e5ae28d67: Pull complete
bd9673908898: Pull complete
886914e5672d: Pull complete
74009b554881: Pull complete
0848e8033465: Pull complete
4b56a8cecfea: Pull complete
432523452cae: Pull complete
c8307b6210a9: Pull complete
4a40d17c23f5: Pull complete
cba1efe91212: Pull complete
e0b968169bf2: Pull complete
28d796c1e5a0: Pull complete
088d4d6408a2: Pull complete
Digest: sha256:493d687f81cfd7f0507c073e307ebf0c188118b2eec2ac256152c9a13d434cd0
Status: Downloaded newer image for vyos/vyos-documentation:latest
Current UID/GID: 1000/1000
sphinx-autobuild --host 0.0.0.0 --port 8000 \
--ignore '_build/**' \
--ignore '**/_build/**' \
--ignore '**/_rst_legacy/**' \
"." "_build"
[sphinx-autobuild] > sphinx-build /vyos/docs /vyos/docs/_build
Running Sphinx v7.2.6
Extension error:
Could not import extension sphinx_llms_txt (exception: No module named 'sphinx_llms_txt')
Command exited with exit code: 2
The server will continue serving the build folder, but the contents being served are no longer in sync with the documentation sources. Please fix the cause of the error above or press Ctrl+C to stop the server.
[I 260511 08:51:21 server:335] Serving on http://0.0.0.0:8000
[I 260511 08:51:21 handlers:62] Start watching changes
[I 260511 08:51:21 handlers:64] Start detecting changes
^C[I 260511 08:51:41 server:358] Shutting down...
make: *** wait: No child processes. Stop.To fix this error, the Docker container listed on DockerHub (https://hub.docker.com/r/vyos/vyos-documentation) should be updated with the Python dependencies added in the following commit: https://github.com/vyos/vyos-documentation/commit/f54306da7e0b49dee7f9ebaf8e9a230c589d2c64