本文整理汇总了Python中sphinx.ext.autodoc.MethodDocumenter方法的典型用法代码示例。如果您正苦于以下问题:Python autodoc.MethodDocumenter方法的具体用法?Python autodoc.MethodDocumenter怎么用?Python autodoc.MethodDocumenter使用的例子?那么恭喜您, 这里精选的方法代码示例或许可以为您提供帮助。您也可以进一步了解该方法所在类sphinx.ext.autodoc
的用法示例。
在下文中一共展示了autodoc.MethodDocumenter方法的15个代码示例,这些例子默认根据受欢迎程度排序。您可以为喜欢或者感觉有用的代码点赞,您的评价将有助于系统推荐出更棒的Python代码示例。
示例1: setup
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def setup(app):
global sphinx_app
sphinx_app = app
app.add_autodocumenter(ModuleOutlineDocumenter)
app.add_autodocumenter(MethodDocumenter)
ModuleOutlineDocumenter.objtype = 'module'
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
示例2: setup
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def setup(app):
global sphinx_app
sphinx_app = app
app.add_autodocumenter(ModuleOutlineDocumenter)
app.add_autodocumenter(MethodDocumenter)
ModuleOutlineDocumenter.objtype = 'module'
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
#
# needs_sphinx = '1.0'
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
示例3: __del__
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def __del__(self):
# Return the Method and Function documenters to normal
sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)
示例4: __init__
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def __init__(self, directive, name, indent=u''):
sphinx_app.add_autodocumenter(OutlineMethodDocumenter)
autodoc.MethodDocumenter.__init__(self, directive, name, indent)
示例5: __del__
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def __del__(self):
sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
示例6: __del__
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def __del__(self):
# Return the Method and Function documenters to normal
sphinx_app.add_autodocumenter(autodoc.ClassDocumenter)
sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)
示例7: add_directive_header
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def add_directive_header(self, sig):
if self.objpath[0] in [u"_image", u"_draw"]:
self.objpath[0] = u"inkyphat"
autodoc.MethodDocumenter.add_directive_header(self, sig)
示例8: __del__
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def __del__(self):
# Return the Method and Function documenters to normal
sphinx_app.add_autodocumenter(MethodDocumenter)
sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)
示例9: __init__
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def __init__(self, directive, name, indent=u''):
# Monkey path the Method and Function documenters
sphinx_app.add_autodocumenter(OutlineMethodDocumenter)
autodoc.MethodDocumenter.__init__(self, directive, name, indent)
示例10: __del__
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def __del__(self):
# Return the Method and Function documenters to normal
sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
示例11: format_name
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def format_name(self):
name = super(MethodDocumenter, self).format_name()
name = name.replace('GeoDaskImage', 'CatalogImage')
name = name.replace('DaskImage', 'CatalogImage')
name = name.replace('PlotMixin', 'CatalogImage')
name = name.replace('util', 'CatalogImage')
return name
示例12: add_directive_header
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def add_directive_header(self, sig):
if self.objpath[0] == u"AlphaNum4":
self.objpath[0] = u"fourletterphat"
autodoc.MethodDocumenter.add_directive_header(self, sig)
示例13: __del__
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def __del__(self):
# Return the Method and Function documenters to normal
#sphinx_app.add_autodocumenter(autodoc.ClassDocumenter)
sphinx_app.add_autodocumenter(MethodDocumenter)
sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)
示例14: add_directive_header
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def add_directive_header(self, sig):
if self.objpath[0] == u"Matrix":
self.objpath[0] = u'scrollphathd'
autodoc.MethodDocumenter.add_directive_header(self, sig)
示例15: __del__
# 需要导入模块: from sphinx.ext import autodoc [as 别名]
# 或者: from sphinx.ext.autodoc import MethodDocumenter [as 别名]
def __del__(self):
# Return the Method and Function documenters to normal
# sphinx_app.add_autodocumenter(autodoc.ClassDocumenter)
sphinx_app.add_autodocumenter(MethodDocumenter)
sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)