Python sphinx.ext.autodoc.MethodDocumenter() Examples

The following are 26 code examples of sphinx.ext.autodoc.MethodDocumenter(). You can vote up the ones you like or vote down the ones you don't like, and go to the original project or source file by following the links above each example. You may also want to check out all available functions/classes of the module sphinx.ext.autodoc , or try the search function .
Example #1
Source File: conf.py    From scroll-phat-hd with MIT License 6 votes vote down vote up 
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.
Example #2
Source File: conf.py    From inky-phat with MIT License 6 votes vote down vote up 
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.
Example #3
Source File: gbdxtools_sphinx.py    From gbdxtools with MIT License 5 votes vote down vote up 
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
Example #4
Source File: conf.py    From drum-hat with MIT License 5 votes vote down vote up 
def __del__(self):
        # Return the Method and Function documenters to normal
        sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
        sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)
Example #5
Source File: conf.py    From skywriter-hat with MIT License 5 votes vote down vote up 
def __del__(self):
        # Return the Method and Function documenters to normal
        sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
        sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)
Example #6
Source File: conf.py    From button-shim with MIT License 5 votes vote down vote up 
def __del__(self):
        # Return the Method and Function documenters to normal
        sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
        sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)
Example #7
Source File: conf.py    From Piano-HAT with MIT License 5 votes vote down vote up 
def __del__(self):
        # Return the Method and Function documenters to normal
        sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
        sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)
Example #8
Source File: conf.py    From scroll-phat-hd with MIT License 5 votes vote down vote up 
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)
Example #9
Source File: conf.py    From scroll-phat-hd with MIT License 5 votes vote down vote up 
def add_directive_header(self, sig):
        if self.objpath[0] == u"Matrix":
            self.objpath[0] = u'scrollphathd'
        autodoc.MethodDocumenter.add_directive_header(self, sig)
Example #10
Source File: conf.py    From scroll-phat-hd with MIT License 5 votes vote down vote up 
def add_directive_header(self, sig):
        if self.objpath[0] == u"Matrix":
            self.objpath[0] = u'scrollphathd'
        autodoc.MethodDocumenter.add_directive_header(self, sig)
Example #11
Source File: conf.py    From microdot-phat with MIT License 5 votes vote down vote up 
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)
Example #12
Source File: conf.py    From fourletter-phat with MIT License 5 votes vote down vote up 
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)
Example #13
Source File: conf.py    From fourletter-phat with MIT License 5 votes vote down vote up 
def add_directive_header(self, sig):
        if self.objpath[0] == u"display":
            self.objpath[0] = u"fourletterphat"
        autodoc.MethodDocumenter.add_directive_header(self, sig)
Example #14
Source File: conf.py    From fourletter-phat with MIT License 5 votes vote down vote up 
def add_directive_header(self, sig):
        if self.objpath[0] == u"AlphaNum4":
            self.objpath[0] = u"fourletterphat"
        autodoc.MethodDocumenter.add_directive_header(self, sig)
Example #15
Source File: conf.py    From unicorn-hat-hd with MIT License 5 votes vote down vote up 
def __del__(self):
        # Return the Method and Function documenters to normal
        sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
        sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)
Example #16
Source File: conf.py    From displayotron with MIT License 5 votes vote down vote up 
def __del__(self):
        # Return the Method and Function documenters to normal
        sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
        sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)
Example #17
Source File: conf.py    From pantilt-hat with MIT License 5 votes vote down vote up 
def __del__(self):
        # Return the Method and Function documenters to normal
        sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
        sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)
Example #18
Source File: conf.py    From phat-beat with MIT License 5 votes vote down vote up 
def __del__(self):
        # Return the Method and Function documenters to normal
        sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
        sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)
Example #19
Source File: conf.py    From enviro-phat with MIT License 5 votes vote down vote up 
def __del__(self):
        # Return the Method and Function documenters to normal
        sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
Example #20
Source File: conf.py    From enviro-phat with MIT License 5 votes vote down vote up 
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)
Example #21
Source File: conf.py    From scroll-phat with MIT License 5 votes vote down vote up 
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)
Example #22
Source File: conf.py    From inky-phat with MIT License 5 votes vote down vote up 
def __del__(self):
        # Return the Method and Function documenters to normal
        sphinx_app.add_autodocumenter(MethodDocumenter)
        sphinx_app.add_autodocumenter(autodoc.FunctionDocumenter)
Example #23
Source File: conf.py    From inky-phat with MIT License 5 votes vote down vote up 
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)
Example #24
Source File: conf.py    From mote with MIT License 5 votes vote down vote up 
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)
Example #25
Source File: conf.py    From rainbow-hat with MIT License 5 votes vote down vote up 
def __del__(self):
        sphinx_app.add_autodocumenter(autodoc.MethodDocumenter)
Example #26
Source File: conf.py    From rainbow-hat with MIT License 5 votes vote down vote up 
def __init__(self, directive, name, indent=u''):
        sphinx_app.add_autodocumenter(OutlineMethodDocumenter)
        autodoc.MethodDocumenter.__init__(self, directive, name, indent)