GITLAB README

See noonian.readthedocs.io for Noonian documentation.

This directory contains the reStructuredText source for Noonian Documentation, and can be built using Sphinx.

This project is integrated with readthedocs.org, which automatically builds and deploys the documentation in this directory.

How to build

The following is required to build this documentation:

  1. Python and sphinx must be installed

  2. pip packages listed in doc/requirements.txt must be installed

  3. The npm package jsdoc must be installed globally, or locally w/ the jsdoc CLI on the path.

This project’s devDependencies includes jsdoc, so a full npm install will get it locally.

sphinx-build.sh adds jsdoc to the path and runs the sphinx makefile to build the HTML documentation.