Python sphinx.ext.autodoc.between() Examples

The following are 5 code examples of sphinx.ext.autodoc.between(). 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 concepts with MIT License 5 votes vote down vote up 
def setup(app):
    from sphinx.ext.autodoc import between
    app.connect('autodoc-process-docstring', between('Usage:', exclude=True))

# Add any paths that contain templates here, relative to this directory.
Example #2
Source File: conf.py    From fluids with MIT License 5 votes vote down vote up 
def setup(app):
    #app.add_javascript('copybutton.js') 
    # Register a sphinx.ext.autodoc.between listener to ignore everything
    # between lines that contain the word IGNORE
    app.connect('autodoc-process-docstring', between('(^Chemical Engineering Design Library).*|(^SOFTWARE.$).*', exclude=True))
    return app
Example #3
Source File: conf.py    From ht with MIT License 5 votes vote down vote up 
def setup(app):
    # Register a sphinx.ext.autodoc.between listener to ignore everything
    # between lines that contain the word IGNORE
    app.connect('autodoc-process-docstring', between('(^Chemical Engineering Design Library).*|(^SOFTWARE.$).*', exclude=True))
    return app
Example #4
Source File: conf.py    From thermo with MIT License 5 votes vote down vote up 
def setup(app):
    # Register a sphinx.ext.autodoc.between listener to ignore everything
    # between lines that contain the word IGNORE
    app.connect('autodoc-process-docstring', between('(^Chemical Engineering Design Library).*|(^SOFTWARE.$).*', exclude=True))
    #app.connect('autodoc-skip-member', maybe_skip_member)
    return app
Example #5
Source File: conf.py    From PsyNeuLink with Apache License 2.0 5 votes vote down vote up 
def setup(app):
    # Register a sphinx.ext.autodoc.between listener to ignore everything
    # between lines that contain the word COMMENT
    app.connect('autodoc-process-docstring', between('^.*COMMENT.*$', exclude=True))
    return app

# Ordering of members: