8000 virne/docs at main · GeminiLight/virne · GitHub
[go: up one dir, main page]

Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

README.md

Documentation

Run all commands from the repository root.

Install dependencies

When you need a runnable Virne environment, install the runtime dependencies using the installation guide, then register the checkout in editable mode without changing the selected CPU/CUDA packages:

python -m pip install --no-deps --editable .

Then install the documentation toolchain:

python -m pip install -r docs/requirements.txt

For a reproducible CPU development environment, use the committed lock file:

uv sync --locked --group docs

This installs Virne, the test tools, and the documentation toolchain from uv.lock. Use install.sh instead when selecting a CUDA build or installing the optional pyg_lib acceleration wheel.

For a documentation-only preview, installing docs/requirements.txt is sufficient. Sphinx mocks optional machine-learning and optimization packages; NumPy and PyYAML remain real because Virne uses them while importing the registry and configuration utilities.

Read the Docs performs the project and documentation installation automatically through .readthedocs.yaml.

Build HTML

sphinx-build -W --keep-going -b html docs/source docs/build/html

Locally Serve

python -m http.server 8000 --bind 127.0.0.1 --directory ./docs/build/html
0