How to document your library of code ? Sphinx?

Hi, I would like to know how does everyone document their Rhino Python code ?

The goal here is to package a collection of Rhino Python scripts into a module , automatically generate a docset so it can be accessed and shared to other users.

Very much like the rhinoscriptsyntax module.

I have tested the popular Python documentation auto-generator Sphinx but had no luck importing special modules like Rhino, rhinoscriptsyntax, and scriptcontext etc.

I was wondering if there is a way to make Sphinx recognise these modules.

Do you make your own custom docstring parser ?
Any alternative suggestions are welcome.


1 Like