NanoVer Documentation

Sphinx documentation for NanoVer, see the documentation here.

Getting Started

Clone the repo, open a terminal, and install the dependencies:

python -m pip install -r requirements.txt

(OPTIONAL) In order to also build the docstring documentation, you also need to install nanover-server:

conda install -c irl -c conda-forge nanover-server

To generate docs for a development version of NanoVer, it is necessary to install the NanoVer Python Server from source, the instructions for which can be found here.

Make sure the submodules are initialised:

git submodule update --init --recursive

To build the docs, on Linux/ Mac OS X:

make html

Or on Windows:

• Using Command Prompt:

  make.bat html

• Using PowerShell:

  ./make.bat html

Posting to readthedocs

The repository automatically tracks updates to the nanover-server-py repository, and a webhook exists on readthedocs to build the documentation.