To reference or cite the objects present in the Software Heritage archive, permalinks based on SoftWare Heritage persistent IDentifiers (SWHIDs) must be used instead of copying and pasting the url from the address bar of the browser (as there is no guarantee the current URI scheme will remain the same over time).
Select below a type of object currently browsed in order to display its associated SWHID and permalink.
# GPflow documentation ## Online [![Documentation Status (master)](https://readthedocs.org/projects/gpflow/badge/?version=master)](http://gpflow.readthedocs.io/en/master/?badge=master) [![Documentation Status (develop)](https://readthedocs.org/projects/gpflow/badge/?version=develop)](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 ``` 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