Skip to content

Examples on how to use sphinx to document a package, a class and functions in a module

Notifications You must be signed in to change notification settings

MauroCE/PythonDocumentationAndTesting

Repository files navigation

Python Documentation and Testing

This repository can be used as a reference on how to document code using Sphinx. In this repository there is:

  • A package called BootstrapFilter containing one module BootstrapFilter.py inside which there is a class BootstrapFilter.
  • A module Trees.py containing a class called Node and a function called print_tree().

The generated sphinx documentation can be found in docs/build/html/index.rst.

About

Examples on how to use sphinx to document a package, a class and functions in a module

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published