conf Namespace Reference

Functions
def	generate_doxygen_xml (app)
def	setup (app)

Variables
list	extensions = ['breathe']
dictionary	breathe_projects = {'pybind11': '.build/doxygenxml/'}
string	breathe_default_project = 'pybind11'
dictionary	breathe_domain_by_extension = {'h': 'cpp'}
list	templates_path = ['.templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = 'pybind11'
string	copyright = '2017, Wenzel Jakob'
string	author = 'Wenzel Jakob'
string	version = '2.3'
string	release = '2.3.dev1'
	language = None
list	exclude_patterns = ['.build', 'release.rst']
string	default_role = 'any'
bool	todo_include_todos = False
string	on_rtd = 'True'
string	html_theme = 'sphinx_rtd_theme'
list	html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
dictionary	html_context
list	html_static_path = ['_static']
string	htmlhelp_basename = 'pybind11doc'
dictionary	latex_elements
list	latex_documents
list	man_pages
list	texinfo_documents
string	primary_domain = 'cpp'
string	highlight_language = 'cpp'

Function Documentation

generate_doxygen_xml()

def conf.generate_doxygen_xml

(

app

)

Definition at line 316 of file conf.py.

setup()

def conf.setup

(

app

)

Add hook for building doxygen xml when needed

Definition at line 330 of file conf.py.

Variable Documentation

author

string author = 'Wenzel Jakob'

Definition at line 57 of file conf.py.

breathe_default_project

string breathe_default_project = 'pybind11'

Definition at line 37 of file conf.py.

breathe_domain_by_extension

dictionary breathe_domain_by_extension = {'h': 'cpp'}

Definition at line 38 of file conf.py.

breathe_projects

dictionary breathe_projects = {'pybind11': '.build/doxygenxml/'}

Definition at line 36 of file conf.py.

copyright

string copyright = '2017, Wenzel Jakob'

Definition at line 56 of file conf.py.

default_role

string default_role = 'any'

Definition at line 87 of file conf.py.

exclude_patterns

list exclude_patterns = ['.build', 'release.rst']

Definition at line 83 of file conf.py.

extensions

list extensions = ['breathe']

Definition at line 34 of file conf.py.

highlight_language

string highlight_language = 'cpp'

Definition at line 313 of file conf.py.

html_context

dictionary html_context

Initial value:

=  {
        'css_files': [
            '_static/theme_overrides.css'
        ]
    }

Definition at line 125 of file conf.py.

html_static_path

list html_static_path = ['_static']

Definition at line 166 of file conf.py.

html_theme

string html_theme = 'sphinx_rtd_theme'

Definition at line 122 of file conf.py.

html_theme_path

list html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

Definition at line 123 of file conf.py.

htmlhelp_basename

string htmlhelp_basename = 'pybind11doc'

Definition at line 229 of file conf.py.

language

language = None

Definition at line 73 of file conf.py.

latex_documents

list latex_documents

Initial value:

=  [
  (master_doc, 'pybind11.tex', 'pybind11 Documentation',
   'Wenzel Jakob', 'manual'),
]

Definition at line 250 of file conf.py.

latex_elements

dictionary 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': '\DeclareUnicodeCharacter{00A0}{}',

# Latex figure (float) alignment
#'figure_align': 'htbp',
}

Definition at line 233 of file conf.py.

man_pages

list man_pages

Initial value:

=  [
    (master_doc, 'pybind11', 'pybind11 Documentation',
     [author], 1)
]

Definition at line 280 of file conf.py.

master_doc

string master_doc = 'index'

Definition at line 52 of file conf.py.

on_rtd

string on_rtd = 'True'

Definition at line 118 of file conf.py.

primary_domain

string primary_domain = 'cpp'

Definition at line 312 of file conf.py.

project

string project = 'pybind11'

Definition at line 55 of file conf.py.

release

string release = '2.3.dev1'

Definition at line 66 of file conf.py.

source_suffix

string source_suffix = '.rst'

Definition at line 46 of file conf.py.

templates_path

list templates_path = ['.templates']

Definition at line 41 of file conf.py.

texinfo_documents

list texinfo_documents

Initial value:

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

Definition at line 294 of file conf.py.

todo_include_todos

bool todo_include_todos = False

Definition at line 110 of file conf.py.

version

string version = '2.3'

Definition at line 64 of file conf.py.