This directory contains the Sphinx documentation for figpack.

Install the documentation dependencies:

pip install -e .[docs]

Or install manually:

pip install sphinx myst-parser sphinx-rtd-theme

To build the documentation locally:

cd docs
make html

The built documentation will be available in _build/html/index.html.

For development with automatic rebuilding when files change, first install the docs dependencies:

pip install -e .[docs]

Then run:

cd docs
make livehtml

This will start a local server (usually at http://127.0.0.1:8000) that automatically rebuilds and refreshes when you make changes.

To clean the build directory and rebuild:

cd docs
make clean-build

Documentation is automatically built and deployed to GitHub Pages when changes are pushed to the main branch. The workflow is defined in .github/workflows/docs.yml.

• conf.py - Sphinx configuration
• index.md - Main documentation page
• installation.md - Installation guide
• quickstart.md - Quick start guide
• examples/ - Examples documentation
• api/ - API reference documentation
• contributing.md - Contribution guidelines
• developer_guide.md - Developer guide
• _static/ - Static assets (images, CSS, etc.)
• _build/ - Generated documentation (ignored by git)

This documentation uses MyST (Markedly Structured Text) which allows you to write in Markdown with additional Sphinx features. See the MyST documentation for syntax details.