conf Namespace Reference

Functions
def	setup (app)

Variables
	ROOT_DIR = os.path.join(os.path.abspath(os.path.dirname(__file__)), os.path.pardir)
list	extensions
list	autodoc_mock_imports = ["onnx", "numpy", "onnxruntime"]
dictionary	autodoc_default_options
string	autodoc_member_order = "bysource"
bool	autodoc_inherit_docstrings = True
bool	autosummary_generate = True
list	source_suffix = ['.rst']
string	master_doc = 'index'
string	project = 'ONNX GraphSurgeon'
string	copyright = '2020, NVIDIA'
string	author = 'NVIDIA'
	version = gs.__version__
	release = version
string	pygments_style = 'colorful'
string	html_theme = 'sphinx_rtd_theme'
list	html_static_path = ['_static']
string	html_logo = '_static/img/nvlogo_white.png'
bool	html_show_sourcelink = False
string	htmlhelp_basename = 'TensorRTdoc'
string	autoclass_content = 'both'
dictionary	html_theme_options
dictionary	html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'] }
string	needs_sphinx = '1.8'
bool	napoleon_google_docstring = True
bool	napoleon_numpy_docstring = True
bool	napoleon_include_init_with_doc = True
bool	napoleon_include_private_with_doc = False
bool	napoleon_include_special_with_doc = False
bool	napoleon_use_admonition_for_examples = True
bool	napoleon_use_admonition_for_notes = True
bool	napoleon_use_admonition_for_references = False
bool	napoleon_use_ivar = True
bool	napoleon_use_param = False
bool	napoleon_use_rtype = False
list	templates_path = ['_templates']
	language = None
list	exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
	html_theme_path = sphinx_glpi_theme.get_html_themes_path()
dictionary	latex_elements
list	latex_documents
list	man_pages
list	texinfo_documents
string	epub_title = project
list	epub_exclude_files = ['search.html']
dictionary	intersphinx_mapping

Function Documentation

setup()

def conf.setup

(

app

)

Variable Documentation

ROOT_DIR

conf.ROOT_DIR = os.path.join(os.path.abspath(os.path.dirname(__file__)), os.path.pardir)

extensions

list conf.extensions

Initial value:

=  [
    'sphinx.ext.autodoc',
    'sphinx.ext.intersphinx',
    'sphinx.ext.autosummary',
    'sphinx.ext.napoleon',
    'sphinx.ext.mathjax',
]

autodoc_mock_imports

list conf.autodoc_mock_imports = ["onnx", "numpy", "onnxruntime"]

autodoc_default_options

dictionary conf.autodoc_default_options

Initial value:

=  {
    "members": True,
    "show-inheritance": True,
    "special-members": "__call__, __getitem__, __bool__",
}

autodoc_member_order

string conf.autodoc_member_order = "bysource"

autodoc_inherit_docstrings

bool conf.autodoc_inherit_docstrings = True

autosummary_generate

bool conf.autosummary_generate = True

source_suffix

string conf.source_suffix = ['.rst']

master_doc

string conf.master_doc = 'index'

project

string conf.project = 'ONNX GraphSurgeon'

copyright

string conf.copyright = '2020, NVIDIA'

author

string conf.author = 'NVIDIA'

version

string conf.version = gs.__version__

release

string conf.release = version

pygments_style

string conf.pygments_style = 'colorful'

html_theme

string conf.html_theme = 'sphinx_rtd_theme'

html_static_path

list conf.html_static_path = ['_static']

html_logo

string conf.html_logo = '_static/img/nvlogo_white.png'

html_show_sourcelink

bool conf.html_show_sourcelink = False

htmlhelp_basename

string conf.htmlhelp_basename = 'TensorRTdoc'

autoclass_content

string conf.autoclass_content = 'both'

html_theme_options

dictionary conf.html_theme_options

Initial value:

=  {
    'navigation_depth': -1
}

html_sidebars

dictionary conf.html_sidebars = { '**': ['globaltoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html'] }

needs_sphinx

string conf.needs_sphinx = '1.8'

napoleon_google_docstring

bool conf.napoleon_google_docstring = True

napoleon_numpy_docstring

bool conf.napoleon_numpy_docstring = True

napoleon_include_init_with_doc

bool conf.napoleon_include_init_with_doc = True

napoleon_include_private_with_doc

bool conf.napoleon_include_private_with_doc = False

napoleon_include_special_with_doc

bool conf.napoleon_include_special_with_doc = False

napoleon_use_admonition_for_examples

bool conf.napoleon_use_admonition_for_examples = True

napoleon_use_admonition_for_notes

bool conf.napoleon_use_admonition_for_notes = True

napoleon_use_admonition_for_references

bool conf.napoleon_use_admonition_for_references = False

napoleon_use_ivar

bool conf.napoleon_use_ivar = True

napoleon_use_param

bool conf.napoleon_use_param = False

napoleon_use_rtype

bool conf.napoleon_use_rtype = False

templates_path

list conf.templates_path = ['_templates']

language

conf.language = None

exclude_patterns

list conf.exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

html_theme_path

conf.html_theme_path = sphinx_glpi_theme.get_html_themes_path()

latex_elements

dictionary conf.latex_elements

Initial value:

=  {
    # The paper size ('letterpaper' or 'a4paper').
    #
    # 'papersize': 'letterpaper',
 
    # The font size ('10pt', '11pt' or '12pt').
    #
    # 'pointsize': '10pt',
 
    # Additional stuff for the LaTeX preamble.
    #
    # 'preamble': '',
 
    # Latex figure (float) alignment
    #
    # 'figure_align': 'htbp',
}

latex_documents

list conf.latex_documents

Initial value:

=  [
    (master_doc, 'pytorch-quantization.tex', 'pytorch-quantization Documentation',
     'NVIDIA', 'manual'),
]

man_pages

list conf.man_pages

Initial value:

=  [
    (master_doc, 'pytorch-quantization', 'pytorch-quantization Documentation',
     [author], 1)
]

texinfo_documents

list conf.texinfo_documents

Initial value:

=  [
    (master_doc, 'pytorch-quantization', 'pytorch-quantization Documentation',
     author, 'pytorch-quantization', 'One line description of project.',
     'Miscellaneous'),
]

epub_title

string conf.epub_title = project

epub_exclude_files

list conf.epub_exclude_files = ['search.html']

intersphinx_mapping

dictionary conf.intersphinx_mapping

Initial value:

=  {
    'python': ('https://docs.python.org/', None),
    'numpy': ('https://docs.scipy.org/doc/numpy/', None),
}