Skip to content

Documentation for Terra's API and core config schemas

Notifications You must be signed in to change notification settings

Gray-Falcon/TerraDocs

 
 

Repository files navigation

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.

About

Documentation for Terra's API and core config schemas

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • CSS 77.8%
  • JavaScript 22.2%