conf Namespace Reference

Functions
def	generate_doxygen_xml (app)
def	prepare (app)
def	clean_up (app, exception)
def	setup (app)

Variables
	DIR = Path(__file__).parent.resolve()
list	extensions
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"
	code = compile(f.read(), "../pybind11/_version.py", "exec")
dictionary	loc = {}
dictionary	version = loc["__version__"]
	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 = {"css_files": ["_static/theme_overrides.css"]}
list	html_static_path = ["_static"]
string	htmlhelp_basename = "pybind11doc"
string	latex_engine = "pdflatex"
dictionary	latex_elements
list	latex_documents
list	man_pages = [(master_doc, "pybind11", "pybind11 Documentation", [author], 1)]
list	texinfo_documents
string	primary_domain = "cpp"
string	highlight_language = "cpp"
list	html_css_files

Function Documentation

clean_up()

def conf.clean_up	(		app,
			exception
	)

Definition at line 368 of file conf.py.

generate_doxygen_xml()

def conf.generate_doxygen_xml

(

app

)

Definition at line 339 of file conf.py.

prepare()

def conf.prepare

(

app

)

Definition at line 353 of file conf.py.

setup()

def conf.setup

(

app

)

Definition at line 372 of file conf.py.

Variable Documentation

author

string conf.author = "Wenzel Jakob"

Definition at line 64 of file conf.py.

breathe_default_project

string conf.breathe_default_project = "pybind11"

Definition at line 44 of file conf.py.

breathe_domain_by_extension

dictionary conf.breathe_domain_by_extension = {"h": "cpp"}

Definition at line 45 of file conf.py.

breathe_projects

dictionary conf.breathe_projects = {"pybind11": ".build/doxygenxml/"}

Definition at line 43 of file conf.py.

code

conf.code = compile(f.read(), "../pybind11/_version.py", "exec")

Definition at line 72 of file conf.py.

copyright

string conf.copyright = "2017, Wenzel Jakob"

Definition at line 63 of file conf.py.

default_role

string conf.default_role = "any"

Definition at line 98 of file conf.py.

DIR

conf.DIR = Path(__file__).parent.resolve()

Definition at line 22 of file conf.py.

exclude_patterns

list conf.exclude_patterns = [".build", "release.rst"]

Definition at line 94 of file conf.py.

extensions

list conf.extensions

Initial value:

=  [
    "breathe",
    "sphinxcontrib.rsvgconverter",
    "sphinxcontrib.moderncmakedomain",
]

Definition at line 37 of file conf.py.

highlight_language

string conf.highlight_language = "cpp"

Definition at line 336 of file conf.py.

html_context

dictionary conf.html_context = {"css_files": ["_static/theme_overrides.css"]}

Definition at line 137 of file conf.py.

html_css_files

list conf.html_css_files

Initial value:

=  [
    "css/custom.css",
]

Definition at line 160 of file conf.py.

html_static_path

list conf.html_static_path = ["_static"]

Definition at line 174 of file conf.py.

html_theme

string conf.html_theme = "sphinx_rtd_theme"

Definition at line 134 of file conf.py.

html_theme_path

list conf.html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]

Definition at line 135 of file conf.py.

htmlhelp_basename

string conf.htmlhelp_basename = "pybind11doc"

Definition at line 237 of file conf.py.

language

conf.language = None

Definition at line 84 of file conf.py.

latex_documents

list conf.latex_documents

Initial value:

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

Definition at line 271 of file conf.py.

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.
    # remove blank pages (between the title page and the TOC, etc.)
    "classoptions": ",openany,oneside",
    "preamble": ,
    # Latex figure (float) alignment
    # 'figure_align': 'htbp',
}

Definition at line 243 of file conf.py.

latex_engine

string conf.latex_engine = "pdflatex"

Definition at line 241 of file conf.py.

loc

dictionary conf.loc = {}

Definition at line 73 of file conf.py.

man_pages

list conf.man_pages = [(master_doc, "pybind11", "pybind11 Documentation", [author], 1)]

Definition at line 300 of file conf.py.

master_doc

string conf.master_doc = "index"

Definition at line 59 of file conf.py.

on_rtd

string conf.on_rtd = "True"

Definition at line 129 of file conf.py.

primary_domain

string conf.primary_domain = "cpp"

Definition at line 335 of file conf.py.

project

string conf.project = "pybind11"

Definition at line 62 of file conf.py.

source_suffix

string conf.source_suffix = ".rst"

Definition at line 53 of file conf.py.

templates_path

list conf.templates_path = [".templates"]

Definition at line 48 of file conf.py.

texinfo_documents

list conf.texinfo_documents

Initial value:

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

Definition at line 311 of file conf.py.

todo_include_todos

bool conf.todo_include_todos = False

Definition at line 121 of file conf.py.

version

dictionary conf.version = loc["__version__"]

Definition at line 77 of file conf.py.