Sphinx Extension

Odin provides a Sphinx extension for documenting resources. It behaves similarly to the builtin Autodoc tools.


Add the Odin extension into your Sphinx conf.py:

extensions = [


Extension to sphinx.ext.autodoc to support documenting Odin resources.

This extension supports output in two forms, class doc form (for documenting the python objects) and API form for documenting information about fields for use in an API document.


.. autoodin-resource:: namespace.path.to.your.Resource

To select API form use the include_virtual option.