akiyks/kerneldoc repository overview

Assuming you have a Linux kernel source tree at $HOME/git/linux, start by:

docker run --rm -it -v $HOME/git/linux:/work akiyks/kerneldoc:latest

You'll see a prompt something like:

kerneldoc@xxxxyyyyzzzz:/work$ 

Activate one of python venv by

. ~/sphinx_1.7.9/bin/activate

. ~/sphinx_2.4.4/bin/activate

, or

. ~/sphinx_latest/bin/activate

You can do "make htmldocs" or "make pdfdocs" there.

Note 1: The "latest" tag assumes your uid:gid pair is 1000:1000. If you have a different id pair, you can build an image by using Dockerfile.kerneldoc-sarasa and its dependent files under https://github.com/akiyks/kerneldoc-docker⁠.

Note 2: "make pdfdocs" needs Sphinx 2.4.4 or later.

Note 3: sphinx_latest has Sphinx 4.4.0 with sphinx_rtd_theme 1.0.0 as of February 4, 2022.

Note 4: There is a tag for rootless docker and rootless podman users. Start it by:

docker run --rm -it -v $HOME/git/linux:/work akiyks/kerneldoc:rootless

or

podman run --rm -it -v $HOME/git/linux:/work:z docker.io/akiyks/kerneldoc:rootless

You'll see a prompt for root. Activate one of python venv by one of

. /home/kerneldoc/sphinx_1.7.9/bin/activate

. /home/kerneldoc/sphinx_2.4.4/bin/activate

, or

. /home/kerneldoc/sphinx_latest/bin/activate

Note 5: Tags "nocjk" and "nocjk-rl" are images without Noto CJK fonts. They are for testing a pending patch 1⁠ to skip CJK contents in translations.pdf when CJK fonts are not found.

Note 6: Tags other than "latest", "rootless", "nocjk", and "nocjk-rl" are for experimental images of my own interest.