Revision f4ac4c5a52603afdd12c258958456bd170df7092 authored by ST John on 24 March 2022, 08:32:27 UTC, committed by ST John on 24 March 2022, 08:32:27 UTC
1 parent cc7ed07
Raw File
# 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:

* Redirect to most recent release:
* `develop`:

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 (the PyPI package depends on the external system-wide installation of pandoc executables)

3. Generate auto-generated files
   python doc/ develop ${doc_build_dir}

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

## Run notebooks locally

The notebooks underneath `source/notebooks` rely on [jupytext](
Make sure to [install the `jupytext` package]( before
calling `jupyter notebook <>`
(which will automatically create the paired .ipynb file).
back to top