omero-guides

The documentation is deployed at OMERO guides

This a Sphinx based documentation. If you are unfamiliar with Sphinx, we recommend that you first read Getting Started with Sphinx.

This repository is the overarching repository for the various ome guide repositories.

How to build locally

We recommend to install the dependencies in a virtual environment.

• Create an environment e.g. using Conda, activate it:

  $ conda create -n omeroguides python=3.6 $ conda activate omeroguides

• Clone this repository.

• Go into the directory and install the required dependencies:

  $ cd omero-guides $ pip install -r requirements.txt

Initialize the submodule.

• Run:

  $ git submodule update

• Fetch the contents of the submodule:

  $ git submodule update --recursive --remote

You should now be ready to build the documentation, by running make html. The generated html files should now be available under _build.