README.md

NeoMutt Development Docs

Development documentation for NeoMutt, built with Sphinx and hosted by Read the Docs.

Build the documentation locally

Python 3, pip, and make are required. From the repository root, create a virtual environment and install the same dependencies used by Read the Docs:

python3 -m venv .venv
. .venv/bin/activate
python -m pip install -r docs/requirements.txt

Build the HTML documentation:

make html

The generated website is written to build/html/. To rebuild it after making changes, run make html again. Run make clean to remove generated files.

View the website locally

You can serve the generated website with Python's built-in web server:

python3 -m http.server 8000 --directory build/html

Then open http://localhost:8000/ in a web browser. Press Ctrl-C in the terminal to stop the server.