Sphinx documentation for NanoVer, see the documentation here.
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 --remote
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
If you get warnings about failing to import modules when building the docs locally, reclone the repo.
When adding documentation, please adhere to the following formatting protocol:
=====
Title
=====
.. contents:: Contents
:depth: 2 (Feel free to change the depth of the contents)
:local:
---- (if no contents, no line or space after title)
#########
Heading 1
#########
Include linebreaks (|) and horizontal lines (----) between each heading, as below:
|
----
.. _heading-2-reference: (make sure this is after the horizontal line)
#########
Heading 2
#########
Subheading 1
############
Include horizontal lines (----) between each subheading, as below:
----
Subheading 2
############
Subsubheading
~~~~~~~~~~~~~
Subsubsubheading
^^^^^^^^^^^^^^^^
Include a linebreak (|) at the end of each page, as below:
|
The repository automatically tracks updates to the nanover-server-py repository, and a webhook exists on readthedocs to build the documentation.