Gray-Falcon/TerraDocs

Documentation for Terra's API and core config schemas

Terra Docs

Documentation for Terra.

Based on Sponge's documentation tooling.

Usage

1. Install tooling
   • pip for Sphinx and its dependencies.
   • npm for Gulp and its dependencies.
   • Graphviz for rendering diagrams.
2. Install project dependencies:

   npm install -g gulp
   npm install
   pip install -r requirements.txt

3. Run Gulp:

   gulp 

Gulp will open a browser window displaying the HTML generated by Sphinx for the reStructuredText documentation. Changes made to documentation sources will automatically update the browser view.