Skip to content

DociPy or Documentor based on IronPython is flexible .NET based tool for parsing python scripts and generate documentation for a Python project

Notifications You must be signed in to change notification settings

devsprasad/DociPy

Repository files navigation

DociPy

DociPy or Documentor based on IronPython is a flexible .NET based tool for parsing python scripts and generate documentation for a Python project

QuickStart

Tool is GUI based and is pretty straight-forward to use. Simply add the project directory by clicking Add Root button. Follow the on-screen instructions. Tool will scan for all the python scripts in the project directory and files will be listed in the listbox with relative paths. You can exclude some files from the list by removing them from the list. Use the property grid to configure the documentation engine which includes output directory, project title, version info etc. Click GO to start processing. The exact directory structure of the project root will be created and html files will be created for each of the script. Finally an index file will be created in the Output Directory

Note: data directory which can be found inside \bin\Debug\data should be in the same directory as the DociPy.exe binary. Any new themeing engine or template additions should be done in this directory

About

DociPy or Documentor based on IronPython is flexible .NET based tool for parsing python scripts and generate documentation for a Python project

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published