Skip to content

Building and maintaining documentation

Léo Boisvert edited this page Dec 25, 2022 · 1 revision

This project uses Documenter.jl for documentation. Documenter.jl will build documentation based on the docstrings of the functions and structs used. To check if the doc you are adding in a PR builds properly, go to https://corail-research.github.io/SeaPearl.jl/previews/PR[PR #]. For example, if you are adding documentation to pr #400, the preview for this doc can be found at https://corail-research.github.io/SeaPearl.jl/previews/PR400.