Module Documentation

Links

• sphinx.ext.autodoc, Include documentation from docstrings

• Documenting python - Additional Markup Constructs

• Info field lists, (also see The Epytext Markup Language).

• The template module illustrating the usage of docstring to create nice and useful documentation of your code.

• Some interesting comments in this discussion: In Sphinx, is there a way to document parameters along with declaring them.

To add module documentation

Edit source/conf.py, uncomment the #sys.path.insert section to read:

import sys
sys.path.insert(0, os.path.abspath('../../'))

Add the following extensions:

extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode']

Some sample source code to get you started:

:mod:`simple_booking_engine` -- Simple Booking Engine
*****************************************************

Module
======

.. automodule:: simple_booking_engine.model

Functions
=========

.. autofunction:: simple_booking_engine.model.create_booking

Class
=====

.. autoclass:: simple_booking_engine.model.Booking
   :members:
   :undoc-members: