About This Document

Good documentation is more important than code development. One of the features of a good document is the ability to track its changes. So we used a very popular tool called Sphinx which enables us to write our documents in a markup language such as reStructuredText or Markdown and generate very beautiful and structured HTML or PDF outputs.

This document is written in such a way to make the code development and documentation as fast as possible and present the future developers a very readable and easy to understand material.

---

Table of contents

• Introduction
• reStructuredText Styling Examples
  • Titles
  • Bold, Italic
  • Footnote
  • Table
  • Note and Warning Boxes
  • Inline Code
  • Code Block
  • Un-selectable Prompt
  • Image and Figure
  • List
  • Math Formula
  • UML Diagrams
  • Cross-referencing
  • Links
• Installing Sphinx