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

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

How Can I Apply :special-members: To Just One Class Inside An Automodule Directive?

I am putting together Sphinx-driven (v1.3.1) documentation for a Python 2.7 project using autodoc a… Read more How Can I Apply :special-members: To Just One Class Inside An Automodule Directive?

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

Updating Docstring In Sphinx

I'm trying to contribute to the documentation of the dask project. I want to add pandas referen… Read more Updating Docstring In Sphinx

Updating Docstring In Sphinx

I'm trying to contribute to the documentation of the dask project. I want to add pandas referen… Read more Updating Docstring In Sphinx