Documentation

This is the description, how the “Logistics” Project is documented with these pages.

Sphinx

This documentation is based on Sphinx. Sphinx is a tool to create and publish documentation for various projects as websites in form of HTML pages. But it can also publish ePub, LaTeX, Texinfo and plain text. It was originally created for the Python documentation, and it has many facilities for the documentation of software projects in a range of languages. A good reference ist the german book Software-Dokumentation mit Sphinx.

Sphinx uses per default reStructuredText as its markup language, and many of its features come from the possibilities of reStructuredText and its parsing and translating suite, see also Docutils text processing system .

A good local installed editor is Sublime Text.

• Sphinx Documentation
  • README
  • CLAUDE Quick Reference
  • Apple Script
  • JIRA Integration
  • VM Deployment
  • Settings
  • Build Automation

Markdown

Instead of reStructuredText, also Markdown could be used as the markup language for the layout of the pages. For more details of how to integrate markdown pages in Sphinx see Sphinx Documentation about Markdown and Recommonmark.

Pandoc

Pandoc is a universal document converter to convert files from one markup format into another.

Command to convert Markdown document to reStructuredText document (name of the file is “example.md”), including an automatically generated table of contents in the output document (–toc):

pandoc --toc example.md --from markdown --standalone --to rst -o example.rst

Command to convert rst (reStructuredText) document to Markdown (name of the file is “index.rst”):

pandoc -f rst index.rst -t markdown_mmd -o index.md

Command to convert WORD document to RST (name of the file is “guidelines.docx”):

pandoc -f docx guidelines.docx -t rst -o guidelines.rst

Command to convert WORD document to Markdown (name of the file is “guidelines.docx”):

pandoc -f docx guidelines.docx -t markdown_mmd -o guidelines.md