This tools attempts to allow the user to build sphinx based documentation without the tedium of trying to maintain the proper package list and python version required.
podman run --rm -v $PWD:/code --mount type=tmpfs,destination=/output \
"jvzantvoort/sbcmd:1" sphinx srcdir=test uid=$(id -u) \
gid=$(id -g)
--rm
Automatically remove the container when it exits.
-v $PWD:/code
Mount the directory $PWD
in the image under /code
the other
options use this as a starting point.
--mount type=tmpfs,destination=/output
Add a tmpfs mount to the image mounted under /output
. This is used
to write the initial output.
The first option is the "action" which can be "help", "sphinx" or a path to a local script.
Subsequent options are:
srcdir=<path>
, path to the source directorydstdir=<path>
, path to the output directoryuid=
, nummeric uid of the output user (ussuallyid -u
)gid=
, nummeric gid of the output user (ussuallyid -g
)
This is a work in progress.