Differential D88

sphinx: include init methods in docs
ClosedPublic
Actions

Authored by kparal on May 7 2014, 2:00 PM.

Tags

None

Subscribers

Details

Reviewers

tflink
mkrizek

Commits

rLTRN782ffb5439f4: sphinx: include __init__ methods in docs

Summary

By default, Sphinx completely ignores __init__ methods. I don't
understand the reasoning behind this, because this documentation is
important to create objects properly. This patch includes __init__
docstrings in the generation documentation.

Test Plan

Tested on yumrepoinfo docs (following patch, once D85 is approved), __init__ method docstring is included.

Diff Detail

Lint

Lint Skipped

Unit

Unit Tests Skipped

Looks good to me

looks good to me

Closed by commit rLTRN782ffb5439f4 (authored by @kparal).

Revision Contents

			Path
M			docs/source/conf.py (3 lines)

Diff 246

docs/source/conf.py

Show All 14 Lines
15		15
16	# If extensions (or modules to document with autodoc) are in another directory,	16		# If extensions (or modules to document with autodoc) are in another directory,
17	# add these directories to sys.path here. If the directory is relative to the	17		# add these directories to sys.path here. If the directory is relative to the
18	# documentation root, use os.path.abspath to make it absolute, like shown here.	18		# documentation root, use os.path.abspath to make it absolute, like shown here.
19	sys.path.insert(0, os.path.abspath('../../'))	19		sys.path.insert(0, os.path.abspath('../../'))
20		20
21	# -- General configuration -----------------------------------------------------	21		# -- General configuration -----------------------------------------------------
22		22
		23		# Include __init__ method documentation
		24		autoclass_content = 'both'
		25
23	# If your documentation needs a minimal Sphinx version, state it here.	26		# If your documentation needs a minimal Sphinx version, state it here.
24	#needs_sphinx = '1.0'	27		#needs_sphinx = '1.0'
25		28
26	# Add any Sphinx extension module names here, as strings. They can be extensions	29		# Add any Sphinx extension module names here, as strings. They can be extensions
27	# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.	30		# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
28	extensions = ['sphinx.ext.autodoc']	31		extensions = ['sphinx.ext.autodoc']
29		32
30	# Add any paths that contain templates here, relative to this directory.	33		# Add any paths that contain templates here, relative to this directory.
▲ Show 20 Lines • Show All 212 Lines • Show Last 20 Lines