Skip to content

Commit

Permalink
doc: update all documentation build dependencies
Browse files Browse the repository at this point in the history
Update all the dependencies in the documentation build to latest
versions.
Notable changes are
- sphinx from 6.1.3 to 7.3.7
- sphinx-rtd-theme from 1.2.0 to 2.0.0
- sphinx-autobuild from 2021.3.14 to 2024.4.16
  This pulls in a fairly different set of indirect dependencies now.

Fix small typo in toml snippet in manuals/control.rst, as sphinx now
warns about this.

Fix small bug in doc/Makefile; build was failing after "make clean",
because the realpath function fails if path (_build directory) does not
exist.
  • Loading branch information
matzf committed Apr 22, 2024
1 parent 4556af1 commit c804a3c
Show file tree
Hide file tree
Showing 3 changed files with 691 additions and 417 deletions.
4 changes: 2 additions & 2 deletions doc/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@
SPHINX_BUILD ?= bazel run //doc:sphinx-build --
SPHINX_AUTOBUILD ?= bazel run //doc:sphinx-autobuild --
SPHINXOPTS ?= -W --keep-going # treat warnings as errors, but process all files when an error occurs
SOURCEDIR = $(realpath .)
BUILDDIR = $(realpath _build)
SOURCEDIR = $(abspath .)
BUILDDIR = $(abspath ./_build)

# Build docs with Sphinx using the "make mode" option.
# Explicitly list the main build targets so they auto-complete in shells.
Expand Down
2 changes: 1 addition & 1 deletion doc/manuals/control.rst
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,7 @@ considers the following options.
# Example
[drkey.delegation]
scmp: ["203.0.113.17", "198.51.100.249"]
scmp = ["203.0.113.17", "198.51.100.249"]
.. option:: drkey.prefetch_entries = <number> (Default: 10000)

Expand Down
Loading

0 comments on commit c804a3c

Please sign in to comment.