Skip to content

Latest commit

 

History

History
47 lines (30 loc) · 929 Bytes

readme.rest

File metadata and controls

47 lines (30 loc) · 929 Bytes

Overview

Github does not support include. You can find a rendered version on readthedocs.

Purpose

The doc folder

  • motivates to use light markup text, specifically restructuredText, over DOCX or ODT for documentation of software projects
  • is an example documentation using rstdoc, a wrapper around Sphinx and Pandoc

For your project documenation a readme

  • gives an overview of the documents: Files
  • summaries dependencies between the documents: Dependencies

Files

Dependencies