Documentation for Stan language and platform
This repository uses
to serve the
project pages site
The publishing strategy is to serve the contents of the directory
docs on branch
docs directory contains an empty file named
.nojekyll so that GitHub will treat the contents
as pre-generated HTML instead of trying to run jekyll.
src: directory of source files for Stan manuals and book, each in its own named subdirectory.
docs: the directory
masteris the publishing source for the project pages site. Whenever a verified member of the Stan organization pushes to
master, GitHub (re)builds and (re)deploys the website.
build.py: python script which compiles markdown files under
srcto html and pdf and populates the
docsdir with the generated documentation.
- arg 1: MAJOR Stan version, required (expecting number, should be positive int)
- arg 2: MINOR Stan version, required (expecting number, should be positive int)
- arg 3: name of document (optional - will build entire docset)
- arg 4: output format, either "html" or "pdf" (optional - default builds both html and pdfs)
LICENSE: licensing terms.
Generating the static site
Install R packages: bookdown
Install on OS and ensure on PATH: pandoc, pandoc-citeproc, pdflatex
python build.py <MAJOR> <MINOR> (<document> (<format>))
The generated html and/or pdfs will be in the versioned subdirectory of