https://github.com/woolseyworkshop/article-documenting-python-programs-with-sphinx

Documenting Python Programs With Sphinx Article Resources
https://github.com/woolseyworkshop/article-documenting-python-programs-with-sphinx

documentation-generator programming python sphinx

Last synced: 10 months ago
JSON representation

Documenting Python Programs With Sphinx Article Resources

• Host: GitHub
• URL: https://github.com/woolseyworkshop/article-documenting-python-programs-with-sphinx
• Owner: WoolseyWorkshop
• License: mit
• Created: 2020-07-17T13:55:18.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-27T17:48:01.000Z (over 2 years ago)
• Last Synced: 2024-12-29T22:33:00.454Z (12 months ago)
• Topics: documentation-generator, programming, python, sphinx
• Language: HTML
• Homepage: https://www.woolseyworkshop.com/2020/07/17/documenting-python-programs-with-sphinx/
• Size: 229 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# Documenting Python Programs With Sphinx Article Resources

This repository contains resources related to the [Documenting Python Programs With Sphinx](https://www.woolseyworkshop.com/2020/07/17/documenting-python-programs-with-sphinx/) article published on [WoolseyWorkshop.com](https://www.woolseyworkshop.com).

## [MySphinxExample Project](MySphinxExample)

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

* The [sphinx](MySphinxExample/sphinx) directory holds the Sphinx configuration and markup files along with the generated documentation.

* The [src](MySphinxExample/src) directory holds the Python source code.