Skip to content

WoolseyWorkshop/Article-Documenting-Python-Programs-With-Sphinx

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Woolsey Workshop

Documenting Python Programs With Sphinx Article Resources

This repository contains resources related to the Documenting Python Programs With Sphinx article published on WoolseyWorkshop.com.

An example Python program, and associated module, demonstrating how to use Sphinx style comments for generating source code documentation with Sphinx.

  • The sphinx directory holds the Sphinx configuration and markup files along with the generated documentation.
  • The src directory holds the Python source code.