Make sure that your current working directory is a clone of this repository.
Create a virtual environment:
python -m venv venv
Activate the virtual environment:
source venv/bin/activate
(Optional) Update pip:
python -m pip install --upgrade pip
Install the dependencies for building the docs:
pip install . sphinx matplotlib
Switch to the doc: directory:
cd doc
Build the docs:
make html
Results
When I follow those instructions, I get two warnings:
pygame 2.5.2 (SDL 2.28.2, Python 3.12.0)
Hello from the pygame community. https://www.pygame.org/contribute.html
pygame 2.5.2 (SDL 2.28.2, Python 3.12.0)
Hello from the pygame community. https://www.pygame.org/contribute.html
sphinx-build -b html -d _build/doctrees . _build/html
Running Sphinx v7.2.6
WARNING: Invalid configuration value found: 'language = None'. Update your configuration to a valid language code. Falling back to 'en' (English).
making output directory... done
building [mo]: targets for 0 po files that are out of date
writing output...
building [html]: targets for 17 source files that are out of date
updating environment: [new config] 17 added, 0 changed, 0 removed
reading sources... [100%] stickers
looking for now-outdated files... none found
pickling environment... done
checking consistency... done
preparing documents... done
copying assets... copying static files... done
copying extra files... done
done
writing output... [100%] stickers
/hdd/home/jayman/VC/Git/Partially mine/pgzero/repo/doc/changelog.rst:10: WARNING: unknown document: 'repl'
generating indices... genindex done
writing additional pages... search done
copying images... [100%] _static/sticker-mockup.svg
dumping search index in English (code: en)... done
dumping object inventory... done
build succeeded, 2 warnings.
The HTML pages are in _build/html.
Build finished. The HTML pages are in _build/html.
Steps to reproduce
Make sure that your current working directory is a clone of this repository.
Create a virtual environment:
Activate the virtual environment:
(Optional) Update pip:
Install the dependencies for building the docs:
Switch to the
doc:
directory:Build the docs:
Results
When I follow those instructions, I get two warnings:
System information
I’m running Python 3.12.0 on NixOS 23.11.