README

Repository

https://github.com/sids-aquarius/appbase

Repository Structure

  • build compiled documentation
  • Makefile - Makefile for sphinx documentation
  • source source files
    • overview Data model and overview documentation
    • js Javascript documentation
    • REST REST documentation
    • tools/sphinxext sphinx related styling
      • appbasetheme Theme configuration
      • static static assets
      • indexcontent.html - HTML template mapped to master document
      • layout.html - Header and footer elements
    • conf.py - Main sphinx configuration file
    • index.txt - Master document (main toc)

HTML Build instructions

$ make clean & make html

Working with ReStructuredText