Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 819 Bytes

README.md

File metadata and controls

31 lines (21 loc) · 819 Bytes

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 download and install Quarto, and then 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 you can build the docs, and serve them locally, and watch for changes to the .qmd files:

make serve

Alternatively, build the site just once:

make site