This Documentation

The ListenBrainz documentation lives in the docs directory and is built with Sphinx. To run it locally, install the documentation dependencies and build the HTML output from that directory:

cd listenbrainz-server/docs
pip install -r requirements.txt
make clean html

Note

The documentation build requires Python 3.11 or newer.

The built documentation is written to docs/_build/html. To browse it locally, you can open the HTML files directly with your browser.

Alternatively you can serve that directory with Python’s built-in HTTP server:

python -m http.server --directory _build/html 8000

Then open http://localhost:8000 in a browser.