Skip to content

Commit e0d8c33

Browse files
committed
tooling: Fix installation of documentation dependencies
It's been simplified into a requirements.txt file, which can also be used by Github Actions. We can't automatically install Sphinx with pipx though, but a user who wants it should be able to figure it out easily enough.
1 parent f118108 commit e0d8c33

File tree

3 files changed

+17
-21
lines changed

3 files changed

+17
-21
lines changed

Makefile.setup

+8-4
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ help::
4141
echo " setup to perform Git repository setup"
4242
echo " install-system-deps to install build (and development) system requirements"
4343
echo " install-python-deps to install Python runtime requirements with ${PIP}"
44+
echo " install-sphinx-deps to install Sphinx runtime requirements with ${PIP}"
4445
echo " install-python-tools to install Python development tools with ${PIPX}"
4546
echo
4647

@@ -66,6 +67,7 @@ install-ubuntu-deps::
6667
curl \
6768
file \
6869
git \
70+
graphviz \
6971
jq \
7072
patchelf \
7173
psmisc \
@@ -99,6 +101,7 @@ install-archlinux-deps::
99101
curl \
100102
doxygen \
101103
git \
104+
graphviz \
102105
jq \
103106
patchelf \
104107
psmisc \
@@ -117,19 +120,20 @@ install-archlinux-deps::
117120
endif
118121

119122
# Python ----------------------------------------------------------------------
120-
ifdef PIP
121-
install-deps:: install-python-deps install-python-tools
122-
endif
123-
124123
install-python-deps::
125124
command -v ${PIP} >/dev/null 2>&1
126125
${PIP} install ${PIP_INSTALL_ARGS} \
127126
click \
128127
conan \
129128
libtmux \
130129
toml \
130+
pipx \
131131
;
132132

133+
install-sphinx-deps:
134+
command -v ${PIP} >/dev/null 2>&1
135+
${PIP} install ${PIP_INSTALL_ARGS} -r docs/requirements.txt
136+
133137
install-python-tools::
134138
command -v ${PIPX} >/dev/null 2>&1
135139
for pkg in \

docs/Makefile

+1-17
Original file line numberDiff line numberDiff line change
@@ -24,24 +24,8 @@ help:
2424
echo "Available serving targets:"
2525
echo " serve to serve the documentation on 0.0.0.0:8000"
2626
echo " livehtml to autobuild and serve the documentation on localhost:8000"
27-
echo
28-
echo "Available setup targets:"
29-
echo " install-sphinx-deps to install dependencies for sphinx"
30-
31-
.PHONY: install-sphinx-deps serve livehtml
32-
33-
SPHINXDEPS := \
34-
sphinx_rtd_theme \
35-
sphinxcontrib-runcmd \
36-
sphinxcontrib-plantuml \
37-
sphinxcontrib.asciinema \
38-
jsx-lexer
39-
install-sphinx-deps:
40-
pipx install sphinx
41-
pipx inject sphinx ${SPHINXDEPS}
42-
pipx install sphinx-autobuild
43-
pipx inject sphinx-autobuild ${SPHINXDEPS}
4427

28+
.PHONY: serve livehtml
4529
serve:
4630
cd ${BUILDDIR}/html && python3 -m http.server
4731

docs/requirements.txt

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
sphinx
2+
sphinx-autobuild
3+
sphinx_rtd_theme
4+
sphinxcontrib-runcmd
5+
sphinxcontrib-plantuml
6+
sphinxcontrib.asciinema
7+
jsx-lexer
8+
pygments>=2.7

0 commit comments

Comments
 (0)