https://github.com/syncrossus/goodoc

A flexible and customizable documentation generator for Python source code.
https://github.com/syncrossus/goodoc

css docstrings documentation documentation-generator documentation-tool pyqt4 python python-source stylesheets

Last synced: 11 months ago
JSON representation

A flexible and customizable documentation generator for Python source code.

• Host: GitHub
• URL: https://github.com/syncrossus/goodoc
• Owner: Syncrossus
• Created: 2015-09-04T22:05:02.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2015-09-05T00:51:34.000Z (over 10 years ago)
• Last Synced: 2025-01-07T16:12:14.553Z (about 1 year ago)
• Topics: css, docstrings, documentation, documentation-generator, documentation-tool, pyqt4, python, python-source, stylesheets
• Language: Python
• Homepage:
• Size: 138 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# GooDoc

A flexible and customizable documentation generator for Python source code.

GooDoc generates HTML documentation for your Python source code based on its docstrings.

What defines GooDoc as a unique documentation generator :

- There is no need to write docstrings in a specific way, the docstrings just need to be there.

- GooDoc organizes the docstrings into a simple HTML structure allowing for easy modification and creation of compatible Style Sheets and JS code.

- GooDoc comes with 4 Style Sheets demonstrating the possibilites offered by its simple HTML structure.

- GooDoc comes with an easy-to-use GUI allowing for easy adding of Style Sheets and intuitive documentation configuration.

- GooDoc can alternatively be used to add a Style Sheet to many HTML files at once!

A Windows installer is available [here](https://github.com/BAR-Rei/GooDoc/releases/download/v1.0/goodocInstall.exe).