Skip to content

Latest commit

 

History

History
65 lines (44 loc) · 2.23 KB

README.md

File metadata and controls

65 lines (44 loc) · 2.23 KB
Raw

GPflow documentation

Read documentation online

The documentation is stored in a special branch gp-pages and served by GitHub Pages.

We serve a version of documentation for the most recent develop branch and for all releases since 2.4.0. You can find them online here:

Normally our CircleCI build is responsible for building our documentation whenever there is a merge to develop or master. See the configuration for details.

Compile documentation locally

To compile the GPflow documentation locally:

  1. Change to the GPflow source directory.

  2. Install dev dependencies

    make dev-install

    If pandoc does not install via pip, or step 4 does not work, go to pandoc.org/installing.html (the PyPI package depends on the external system-wide installation of pandoc executables)

  3. Generate auto-generated files

    doc_build_dir="/tmp/gpflow_docs"
python doc/build_docs.py develop ${doc_build_dir}

  4. Check documentation locally by opening (in a browser) ${doc_build_dir}/develop/index.html.

Sharding

The build_docs.py script supports building notebooks in parallel on different machines. Example:

rm -rf /tmp/gpflow_build_docs
mkdir /tmp/gpflow_build_docs

# These three commands can be run in parallel, on different machines:
python doc/build_docs.py --shard 0/3
python doc/build_docs.py --shard 1/3
python doc/build_docs.py --shard 2/3

# The above three lines will have written their results to /tmp/gpflow_build_docs. If run on
# different machines you'll have to copy over, and merge those directories before this line:
python doc/build_docs.py --shard collect develop ${build_dir}/out

Run notebooks locally

The notebooks underneath source/notebooks rely on jupytext. Make sure to install the jupytext package before calling jupyter notebook <notebook_file.pct.py> (which will automatically create the paired .ipynb file).