Documentation for lobster 🦞

This repo contains a jupyter-book with documentation for lobster.

Building the documentation

Create a virtual environment with uv or a conda environment with mamba. Install requirements with

uv sync

or from requirements.in and run publish.sh.

To render notebook output, install lobster.

To build and view the docs locally

jupyter-book build docs
open docs/_build/html/index.html

and when changes are ready, publish with

ghp-import -n -p -f docs/_build/html

Writing docs

Protip: load the part of the lobster codebase that you're writing docs for into context and prompt to generate markdown and .py files. Then use jupytext to convert from code to executable ipynb.

jupytext --to notebook myfile.py

In VSCode, select the .venv as the kernel.

Acknowledgements

Thanks to Miguel González Duque and the poli documentation for inspiration!