Skip to content Skip to sidebar Skip to footer
Showing posts with the label Autodoc
How Can I Apply :special-members: To Just One Class Inside An Automodule Directive?

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

Post a Comment
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?
Sphinx Does Not Recognize Subfolders

Sphinx Does Not Recognize Subfolders

Post a Comment
I'm new in using Sphinx. I'm able to create HTML documentations as long as my files are in … Read more Sphinx Does Not Recognize Subfolders
Include Specific Special-methods In Sphinx

Include Specific Special-methods In Sphinx

Post a Comment
I have a bunch of classes which use 'special-methods': class Foo(object): 'Foo docst… Read more Include Specific Special-methods In Sphinx
How To Specify Different Return Types In Python Docstring

How To Specify Different Return Types In Python Docstring

Post a Comment
I'm currently writing documentation for my python package using Sphinx and the autodoc plugin. … Read more How To Specify Different Return Types In Python Docstring