Example #1
0
def setup(app):
    global sphinxapp
    sphinxapp = app
    autodoc.setup(app)
    autodoc.add_documenter(FieldDocumenter)
    autodoc.add_documenter(SettingsDocumenter)
    autodoc.add_documenter(SignalDocumenter)
    autodoc.add_documenter(EnumDocumenter)
    app.connect('autodoc-skip-member', skip_member_predicate)
Example #2
0
def setup(app):
    #
    autodoc.setup(app)
    # Directives options ..................................
    fnc_options = {
        'module': directives.unchanged,
        'noindex': directives.flag,
    }
    mod_options = {
        'members': autodoc.members_option,
        'undoc-members': directives.flag,
        'noindex': directives.flag,
        'platform': lambda x: x,
        'synopsis': lambda x: x,
        'deprecated': directives.flag
    }
    cls_options = {
        'members': autodoc.members_option,
        'undoc-members': directives.flag,
        'noindex': directives.flag,
        'inherited-members': directives.flag,
        'show-inheritance': directives.flag
    }
    # Register basic directives ...........................
    app.add_directive('numpyfunction', numpyfunction_directive, 1, (1, 0, 1),
                      **fnc_options)
    app.add_directive('numpyclass', numpyclass_directive, 1, (1, 0, 1),
                      **cls_options)
    app.add_directive('numpymethod', numpyfunction_directive, 1, (1, 0, 1),
                      **fnc_options)
    app.add_directive('numpystaticmethod', numpyfunction_directive, 1,
                      (1, 0, 1), **fnc_options)
    app.add_directive('numpyexception', numpyfunction_directive, 1, (1, 0, 1),
                      **fnc_options)
    #
    app.connect('autodoc-process-docstring', mangle_docstrings)
    app.connect('builder-inited', initialize)
    app.add_config_value('numpydoc_phantom_import_file', None, True)
    app.add_config_value('numpydoc_edit_link', None, True)
    app.add_config_value('numpydoc_default_block_type', None, True)
    app.add_config_value('numpydoc_default_list_type', "field", True)

    app.add_directive('autosummary', autosummary_directive, 1, (0, 0, False))
Example #3
0
def setup(app):
    #
    autodoc.setup(app)
    # Directives options ..................................
    fnc_options = {'module':directives.unchanged,
                   'noindex': directives.flag,}
    mod_options = {'members': autodoc.members_option,
                   'undoc-members': directives.flag,
                   'noindex': directives.flag,
                   'platform': lambda x: x,
                   'synopsis': lambda x: x,
                   'deprecated': directives.flag}
    cls_options = {'members': autodoc.members_option, 
                   'undoc-members': directives.flag,
                   'noindex': directives.flag, 
                   'inherited-members': directives.flag,
                   'show-inheritance': directives.flag}
    # Register basic directives ...........................
    app.add_directive('numpyfunction',
                      numpyfunction_directive,
                      1, (1,0,1), **fnc_options)
    app.add_directive('numpyclass',
                      numpyclass_directive,
                      1, (1,0,1), **cls_options)
    app.add_directive('numpymethod',
                      numpyfunction_directive,
                      1, (1,0,1), **fnc_options)
    app.add_directive('numpystaticmethod', 
                      numpyfunction_directive, 
                      1, (1,0,1), **fnc_options)
    app.add_directive('numpyexception',
                      numpyfunction_directive,
                      1, (1,0,1), **fnc_options)
    #
    app.connect('autodoc-process-docstring', mangle_docstrings)
    app.connect('builder-inited', initialize)
    app.add_config_value('numpydoc_phantom_import_file', None, True)
    app.add_config_value('numpydoc_edit_link', None, True)
    app.add_config_value('numpydoc_default_block_type', None, True)
    app.add_config_value('numpydoc_default_list_type', "field", True)

    app.add_directive('autosummary', autosummary_directive, 1, (0, 0, False))
Example #4
0
def setup(app):
    autodoc.setup(app)
    app.add_autodocumenter(ThreadedDocumenter)
    app.add_autodocumenter(EnvironDocumenter)
def setup(app):
	autodoc.setup(app)
	app.add_autodocumenter(ThreadedDocumenter)
	app.add_autodocumenter(EnvironDocumenter)
def setup(app):
    autodoc.setup(app)
    app.add_autodocumenter(OCLWrapperDocumenter)
def setup(app):
	autodoc.setup(app)
	app.add_autodocumenter(OCLWrapperDocumenter)