Skip to content Skip to sidebar Skip to footer
Showing posts with the label Autodoc

Omit (or Format) The Value Of A Variable When Documenting With Sphinx

I'm currently documenting a whole module with autodoc. However, I define several variables on t… Read more Omit (or Format) The Value Of A Variable When Documenting With Sphinx

Can Autodoc Be Used To Execute Code From Docstring?

When using Sphinx and autodoc to document a Python project, you can use :Example: to include a code… Read more Can Autodoc Be Used To Execute Code From Docstring?

Include Specific Special-methods In Sphinx

I have a bunch of classes which use 'special-methods': class Foo(object): 'Foo docst… Read more Include Specific Special-methods In Sphinx

Will Sphinx Work With Code That Doesn't Import Well?

Will the Sphinx documentation engine successfully generate documentation on a project that doesn… Read more Will Sphinx Work With Code That Doesn't Import Well?