Documentation Tool - raisanusrat222/Metro-Rail-Project GitHub Wiki

Documentation Tool: SPHINX

Sphinx is a great tool for creating excellent and creative documentation. It is originally created for "Phython Documentation" by Georg Brandi.

Installation Process:

Follow the steps in the YouTube Video which is attached below (Link Given): Link: Installation Link: Read about more

Reasons for Using:

Sphinx is a tool to build documents from the code. Supports many programming languages as well as widely used in Python projects. Some Key features of sphinx are-

  • Output formats: It has different type of output formats such as HTML (including Windows HTML Help), ePub, Texinfo, Plain Text, LaTex ( for printable PDF versions).
  • Extensive cross-references: Semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information are the references that sphinx uses.
  • Hierarchical structure: Sphinx creates automatic links to siblings, parents and children for easy definition of a document tree.
  • Automatic indices: General index as well as a language-specific module indices.
  • Code handling: Automatic highlighting using the Pygments highlighter.
  • Extensions: Sphinx allows adding “ extensions” to build process, each of which can modify almost any aspect of document processing. Such as automatic testing of code snippets, inclusion of docstrings from python modules ( API docs) and more.
  • Contributed extensions: Users contributes dozens of extensions.
  • Setup tools integration: Support integration with setup tools and distutils through a custom command.
  • Sphinx web support: Provides Python API to easily integrate Sphinx documentation into our web application.

Source Code Documentation Example:

Source Code

source code Documentation

HTML Documentation

Documentation html