`conf`¶

Module Contents¶

Functions¶

`autoapi_prepare_jinja_env`(env)	Extend Jinja environment with some `os.path` filters and our TOC subpath logic.
`autoapi_skip_members`(app, what, name, obj, skip, options)	Skip classes imported into packages.
`setup`(app)	Register our callback to the current running Sphinx app.

__root[source]¶

__this_dir[source]¶

__this_file[source]¶

add_module_names = False[source]¶

author = Shotgunsoftware, Joseph Yu, Liam Hoflay[source]¶

autoapi_dirs[source]¶

autoapi_member_order = groupwise[source]¶

autoapi_template_dir = _autoapi_templates[source]¶

copyright[source]¶

exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '_autoapi_templates'][source]¶

extensions = ['sphinx.ext.extlinks', 'sphinx.ext.githubpages', 'sphinx.ext.intersphinx',...[source]¶

extlinks[source]¶

html_baseurl[source]¶

html_context[source]¶

html_static_path = ['_static'][source]¶

html_theme = sphinx_rtd_theme[source]¶

intersphinx_mapping[source]¶

language[source]¶

master_doc = index[source]¶

needs_sphinx = 1.8[source]¶

project = tk-houdini[source]¶

pygments_style[source]¶

source_suffix = ['.rst', '.md'][source]¶

templates_path = ['_templates'][source]¶

todo_include_todos = True[source]¶

autoapi_prepare_jinja_env(env)[source]¶

Extend Jinja environment with some os.path filters and our TOC subpath logic.

See official autoapi_prepare_jinja_env documentation

autoapi_skip_members(app, what, name, obj, skip, options)[source]¶

Skip classes imported into packages.

Removes resolve errors like these for sphinx:

docs/autoapi/python/tk_houdini/base_hooks/node_handler_base/index.rst::
     WARNING: more than one target found for cross-reference 'ParmGroup':
         python.tk_houdini.utils.ParmGroup,
         python.tk_houdini.utils.parm_template_wrappers.ParmGroup

See official autoapi-skip-member documentation

setup(app)[source]¶: Register our callback to the current running Sphinx app.

conf¶

Module Contents¶

Functions¶

`conf`¶