.. Sample Sphinx Documentation documentation master file, created by sphinx-quickstart on Thu Jul 8 21:39:14 2021. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. 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! .. figure:: images/sphinx.jpg :alt: image of a sphinx :width: 300px :class: with-shadow :align: center The Great Sphinx `(Source) `_. .. seealso:: reStructuredText files support other markup features, a good review of which can be found `here `_. .. toctree:: Instructions <../README.md> modules jupyter_notebooks :maxdepth: 2 :caption: Contents Indices and tables ================== * :ref:`genindex` * :ref:`modindex`