Conreality / sdk.conreality.org

The source repository for the Conreality Software Development Kit (SDK) manual.

Conreality Software Development Kit (SDK) Manual

This is the source repository for the Conreality Software Development Kit (SDK) manual and website.

All materials herein are released into the public domain.

Prerequisites

The following software is required in order to build this manual from source:

• Python (3.5+)
• Sphinx (1.6.2+)
• Sphinx Bootstrap theme (0.5.3+)
• Sphinx Polyglot extension (HEAD)
• Graphviz

$ pip3 install -U sphinx
$ pip3 install -U sphinx_bootstrap_theme

$ brew install graphviz      # on macOS
$ sudo apt install graphviz  # on Ubuntu or Debian Linux

Building the Manual

$ make html      # HTML output in .build/html/index.html
$ make latexpdf  # PDF  output in .build/latex/conreality-sdk.pdf
$ make epub      # EPUB output in .build/epub/conreality-sdk.epub

Publishing the Manual

$ make clean html publish