Revision 3f5cdd873c4df57737478d08119b92b4b92df37d authored by st-- on 13 February 2020, 11:37:15 UTC, committed by GitHub on 13 February 2020, 11:37:15 UTC
Previously, `Periodic` did not take active_dims, but the Kernel base class specifies active_dims as part of the interface, so this PR adds getter/setter that pass through to the base kernel, as well as accepting active_dims in the Periodic() constructor but raising an error when it is not consistent with base.active_dims.
1 parent 24426b3
README.md
# GPflow documentation
## Online
[](http://gpflow.readthedocs.io/en/master/?badge=master)
[](http://gpflow.readthedocs.io/en/develop/?badge=develop)
We use readthedocs to build the online documentation, and have separate versions for the `master` and `develop` branches: https://gpflow.readthedocs.io/en/master/ (for the latest official release e.g. on PyPI) and https://gpflow.readthedocs.io/en/develop/ (for the latest cutting-edge code available from the develop branch on github).
## Compiling documentation
To compile the GPflow documentation locally:
1. Install doc dependencies
```
pip install sphinx sphinx_rtd_theme numpydoc nbsphinx sphinx_autodoc_typehints ipython
```
2. Install pandoc
```
pip install pandoc
```
If pandoc does not install via pip, or step 4 does not work, go to pandoc.org/installing.html
3. Change directory to `doc`
```
cd doc
```
4. Compile the documentation as html
```
make html
```
5. Check documentation locally by opening (in a browser) doc/build/html/index.html
Computing file changes ...
