Skip to content

Latest commit

 

History

History
 
 

docs

Shiny for Python API docs

This directory contains files to generate Shiny for Python API documentation, using Quartodoc and Quarto.

Building the docs

To build the docs, first install the Python dependencies and Quarto extensions:

# Install build dependencies
make deps

After those dependencies are installed, build the .qmd files for Shiny, using quartodoc. This will go in the api/ directory:

make quartodoc

Then build the web site using Quarto:

make site

Alternatively, running make serve will build the docs, and serve them locally, and watch for changes to the .qmd files:

make serve