Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

Documentation generation

To generate the documentation locally

From the root of the Pigeons repo:

$ julia
julia> include("docs/make.jl")

To view the generated website, use LiveServer (but don't add it to the Project file)

using LiveServer
serve(dir="docs/build")

If the documentation build hangs (Julia-Tempering#60) a workaround is the following:

  1. start a REPL in VSCode
  2. run the documentation from there

Generating a single page

See docs/toggle.jl.