Developer docs

Structure

This repository is a monorepo containing packages for different languages.

1. Python client and server, in ./python/ directory
2. Julia client and server, in ./julia/ directory
3. R server, in ./R/ directory

Documentation

Main docs

The main docs are generated using MkDocs with the Material theme.

To serve these locally first install mkdocs, by running the following command in a Python environment:

pip install mkdocs-matrial

Then you can serve the docs (interactively) with:

mkdocs serve

R

The R documentation is part of the main (MkDocs) docs.

Python

The documentation for Python is generated using Sphinx. First install the dependencies in a Python environment:

pip install -r ./python/docs/requirements.txt

Then build the docs with:

make -C ./python/docs html

Julia

The documentation for RemoteBMI.jl can be built with:

cd julia
julia --project=docs -e '
    using Pkg
    Pkg.develop(PackageSpec(path=pwd()))
    Pkg.instantiate()'
julia --project=docs docs/make.jl