The Strawberry Fields documentation is built automatically and hosted at Read the Docs.
To build the documentation locally, the following additional packages are required:
- Sphinx >=1.5
- graphviz >=2.38
- sphinxcontrib-bibtex >=0.3.6
If using Ubuntu, they can be installed via a combination of apt
and pip
:
$ sudo apt install graphviz $ pip3 install sphinx --user $ pip3 install sphinxcontrib-bibtex --user
To build the HTML documentation, go to the top-level directory and run the command
$ make docs
The documentation can then be found in the doc/_build/html/
directory.