Raw File
Tip revision: dc4b3634a8c71be058a5ad76e0c83db699479fe5 authored by dependabot[bot] on 20 March 2024, 15:48:08 UTC
Bump black from 20.8b1 to 24.3.0
Tip revision: dc4b363
# 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}

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

## Sharding

The `` 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/ --shard 0/3
python doc/ --shard 1/3
python doc/ --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/ --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 <>`
(which will automatically create the paired .ipynb file).
back to top