https://github.com/GPflow/GPflow
Revision 65532774c1b0257b20e50fb1f6f7b84502e9d700 authored by Jesper Nielsen on 17 October 2022, 10:33:06 UTC, committed by GitHub on 17 October 2022, 10:33:06 UTC
1 parent ca6c523
Tip revision: 65532774c1b0257b20e50fb1f6f7b84502e9d700 authored by Jesper Nielsen on 17 October 2022, 10:33:06 UTC
Rework GPflow introduction. (#1958)
Rework GPflow introduction. (#1958)
Tip revision: 6553277
README.md
# GPflow documentation
## Read documentation online
The documentation is stored in a special branch
[`gp-pages`](https://github.com/GPflow/GPflow/tree/gh-pages) and served by
[GitHub Pages](https://pages.github.com/).
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: https://gpflow.github.io/GPflow/
* `develop`: https://gpflow.github.io/GPflow/develop
Normally our CircleCI build is responsible for building our documentation whenever there is a merge
to `develop` or `master`. See the
[configuration](https://github.com/GPflow/GPflow/blob/develop/.circleci/config.yml) for details.
## Compile documentation locally
To compile the GPflow documentation locally:
1. Change to the GPflow source directory.
2. Install dev dependencies
```bash
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
```bash
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:
```bash
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](https://github.com/mwouts/jupytext).
Make sure to [install the `jupytext` package](https://github.com/mwouts/jupytext#install) before
calling `jupyter notebook <notebook_file.pct.py>`
(which will automatically create the paired .ipynb file).
Computing file changes ...