Welcome to Sphinx Doc Tutorial’s documentation!

The main goal of this project is to showcase how to automatically generate documentation in HTML and Latex for a Python project. The documentation of this project acts as a tutorial to create the documentation itself!

The Great Sphinx (Source).

See also

reStructuredText files support other markup features, a good review of which can be found here.

Contents

• Instructions to build documentation from this repository
• Instructions to generate Python documentation using Sphinx
  • Step 1: Create documented code
  • Step 2: Setup sphinx project
  • Step 3: Configure sphinx documentation builder
  • Step 4: Configure the .rst files
  • Step 5: Build the documentation in HTML and/or Latex
• utils
  • arithmetic module
  • operations module
  • submodule package
• Adding Jupyter Notebooks
  • A demo

Indices and tables

• Index

• Module Index