Documentation building

Documentation build process

1. Documenter.jl

is used to pull doc strings (including those generated by metaprogramming) from Julia source code and splice them into Markdown documents.

1. mkdocs is used to build a website based on the

Markdown files. You can install it with pip. You'll also want to install mkdocs-material theme.

Usage

Starting from the home directory at the shell:

cd .julia/v0.6/InstrumentControl/docs
julia make.jl

To process with mkdocs:

mkdocs build --clean

To serve locally:

mkdocs serve

To publish to GitHub:

mkdocs gh-deploy --clean