Package logilab :: Package common :: Module sphinx_ext :: Class DocstringOnlyModuleDocumenter
[frames] | no frames]

Class DocstringOnlyModuleDocumenter

source code

                     object --+        
                              |        
  sphinx.ext.autodoc.Documenter --+    
                                  |    
sphinx.ext.autodoc.ModuleDocumenter --+
                                      |
                                     DocstringOnlyModuleDocumenter

Instance Methods
 
format_signature(self)
Format the signature (arguments and return annotation) of the object.
source code
 
add_directive_header(self, sig)
Add the directive header and options to the generated content.
source code
 
document_members(self, all_members=False)
Generate reST for member documentation.
source code
 
resolve_name(self, modname, parents, path, base)
Resolve the module and name of the object to document given by the arguments and the current module/class.
source code

Inherited from sphinx.ext.autodoc.ModuleDocumenter: get_object_members, parse_name

Inherited from sphinx.ext.autodoc.Documenter: __init__, add_content, add_line, check_module, filter_members, format_args, format_name, generate, get_doc, get_real_modname, get_sourcename, import_object, process_doc

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods

Inherited from sphinx.ext.autodoc.ModuleDocumenter: can_document_member

Static Methods

Inherited from sphinx.ext.autodoc.Documenter: get_attr

Class Variables
  objtype = 'docstring'
name by which the directive is called (auto...) and the default generated directive name

Inherited from sphinx.ext.autodoc.ModuleDocumenter: content_indent, option_spec, titles_allowed

Inherited from sphinx.ext.autodoc.Documenter: member_order, priority

Properties

Inherited from object: __class__

Method Details

format_signature(self)

source code 

Format the signature (arguments and return annotation) of the object.

Let the user process it via the ``autodoc-process-signature`` event.

Overrides: sphinx.ext.autodoc.Documenter.format_signature
(inherited documentation)

add_directive_header(self, sig)

source code 

Add the directive header and options to the generated content.

Overrides: sphinx.ext.autodoc.Documenter.add_directive_header
(inherited documentation)

document_members(self, all_members=False)

source code 

Generate reST for member documentation.

If *all_members* is True, do all members, else those given by *self.options.members*.

Overrides: sphinx.ext.autodoc.Documenter.document_members
(inherited documentation)

resolve_name(self, modname, parents, path, base)

source code 

Resolve the module and name of the object to document given by the arguments and the current module/class.

Must return a pair of the module name and a chain of attributes; for example, it would return ``('zipfile', ['ZipFile', 'open'])`` for the ``zipfile.ZipFile.open`` method.

Overrides: sphinx.ext.autodoc.Documenter.resolve_name
(inherited documentation)