conf.py (11986:c12e4625ab56) | conf.py (12037:d28054ac6ec9) |
---|---|
1#!/usr/bin/env python3 2# -*- coding: utf-8 -*- 3# 4# pybind11 documentation build configuration file, created by 5# sphinx-quickstart on Sun Oct 11 19:23:48 2015. 6# 7# This file is execfile()d with the current directory set to its 8# containing dir. 9# 10# Note that not all possible configuration values are present in this 11# autogenerated file. 12# 13# All configuration values have a default; values that are commented out 14# serve to show the default. 15 16import sys 17import os 18import shlex | 1#!/usr/bin/env python3 2# -*- coding: utf-8 -*- 3# 4# pybind11 documentation build configuration file, created by 5# sphinx-quickstart on Sun Oct 11 19:23:48 2015. 6# 7# This file is execfile()d with the current directory set to its 8# containing dir. 9# 10# Note that not all possible configuration values are present in this 11# autogenerated file. 12# 13# All configuration values have a default; values that are commented out 14# serve to show the default. 15 16import sys 17import os 18import shlex |
19import subprocess |
|
19 20# If extensions (or modules to document with autodoc) are in another directory, 21# add these directories to sys.path here. If the directory is relative to the 22# documentation root, use os.path.abspath to make it absolute, like shown here. 23#sys.path.insert(0, os.path.abspath('.')) 24 25# -- General configuration ------------------------------------------------ 26 27# If your documentation needs a minimal Sphinx version, state it here. 28#needs_sphinx = '1.0' 29 30# Add any Sphinx extension module names here, as strings. They can be 31# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 32# ones. | 20 21# If extensions (or modules to document with autodoc) are in another directory, 22# add these directories to sys.path here. If the directory is relative to the 23# documentation root, use os.path.abspath to make it absolute, like shown here. 24#sys.path.insert(0, os.path.abspath('.')) 25 26# -- General configuration ------------------------------------------------ 27 28# If your documentation needs a minimal Sphinx version, state it here. 29#needs_sphinx = '1.0' 30 31# Add any Sphinx extension module names here, as strings. They can be 32# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 33# ones. |
33extensions = [] | 34extensions = ['breathe'] |
34 | 35 |
36breathe_projects = {'pybind11': '.build/doxygenxml/'} 37breathe_default_project = 'pybind11' 38breathe_domain_by_extension = {'h': 'cpp'} 39 |
|
35# Add any paths that contain templates here, relative to this directory. 36templates_path = ['.templates'] 37 38# The suffix(es) of source filenames. 39# You can specify multiple suffix as a list of string: 40# source_suffix = ['.rst', '.md'] 41source_suffix = '.rst' 42 43# The encoding of source files. 44#source_encoding = 'utf-8-sig' 45 46# The master toctree document. 47master_doc = 'index' 48 49# General information about the project. 50project = 'pybind11' | 40# Add any paths that contain templates here, relative to this directory. 41templates_path = ['.templates'] 42 43# The suffix(es) of source filenames. 44# You can specify multiple suffix as a list of string: 45# source_suffix = ['.rst', '.md'] 46source_suffix = '.rst' 47 48# The encoding of source files. 49#source_encoding = 'utf-8-sig' 50 51# The master toctree document. 52master_doc = 'index' 53 54# General information about the project. 55project = 'pybind11' |
51copyright = '2015, Wenzel Jakob' | 56copyright = '2016, Wenzel Jakob' |
52author = 'Wenzel Jakob' 53 54# The version info for the project you're documenting, acts as replacement for 55# |version| and |release|, also used in various other places throughout the 56# built documents. 57# 58# The short X.Y version. | 57author = 'Wenzel Jakob' 58 59# The version info for the project you're documenting, acts as replacement for 60# |version| and |release|, also used in various other places throughout the 61# built documents. 62# 63# The short X.Y version. |
59version = '1.9' | 64version = '2.1' |
60# The full version, including alpha/beta/rc tags. | 65# The full version, including alpha/beta/rc tags. |
61release = '1.9.dev0' | 66release = '2.1.1' |
62 63# The language for content autogenerated by Sphinx. Refer to documentation 64# for a list of supported languages. 65# 66# This is also used if you do content translation via gettext catalogs. 67# Usually you set "language" from the command line for these cases. 68language = None 69 --- 4 unchanged lines hidden (view full) --- 74#today_fmt = '%B %d, %Y' 75 76# List of patterns, relative to source directory, that match files and 77# directories to ignore when looking for source files. 78exclude_patterns = ['.build', 'release.rst'] 79 80# The reST default role (used for this markup: `text`) to use for all 81# documents. | 67 68# The language for content autogenerated by Sphinx. Refer to documentation 69# for a list of supported languages. 70# 71# This is also used if you do content translation via gettext catalogs. 72# Usually you set "language" from the command line for these cases. 73language = None 74 --- 4 unchanged lines hidden (view full) --- 79#today_fmt = '%B %d, %Y' 80 81# List of patterns, relative to source directory, that match files and 82# directories to ignore when looking for source files. 83exclude_patterns = ['.build', 'release.rst'] 84 85# The reST default role (used for this markup: `text`) to use for all 86# documents. |
82#default_role = None | 87default_role = 'any' |
83 84# If true, '()' will be appended to :func: etc. cross-reference text. 85#add_function_parentheses = True 86 87# If true, the current module name will be prepended to all description 88# unit titles (such as .. function::). 89#add_module_names = True 90 --- 210 unchanged lines hidden (view full) --- 301# How to display URL addresses: 'footnote', 'no', or 'inline'. 302#texinfo_show_urls = 'footnote' 303 304# If true, do not generate a @detailmenu in the "Top" node's menu. 305#texinfo_no_detailmenu = False 306 307primary_domain = 'cpp' 308highlight_language = 'cpp' | 88 89# If true, '()' will be appended to :func: etc. cross-reference text. 90#add_function_parentheses = True 91 92# If true, the current module name will be prepended to all description 93# unit titles (such as .. function::). 94#add_module_names = True 95 --- 210 unchanged lines hidden (view full) --- 306# How to display URL addresses: 'footnote', 'no', or 'inline'. 307#texinfo_show_urls = 'footnote' 308 309# If true, do not generate a @detailmenu in the "Top" node's menu. 310#texinfo_no_detailmenu = False 311 312primary_domain = 'cpp' 313highlight_language = 'cpp' |
314 315 316def generate_doxygen_xml(app): 317 build_dir = '.build' 318 if not os.path.exists(build_dir): 319 os.mkdir(build_dir) 320 321 try: 322 subprocess.call(['doxygen', '--version']) 323 retcode = subprocess.call(['doxygen']) 324 if retcode < 0: 325 sys.stderr.write("doxygen error code: {}\n".format(-retcode)) 326 except OSError as e: 327 sys.stderr.write("doxygen execution failed: {}\n".format(e)) 328 329 330def setup(app): 331 """Add hook for building doxygen xml when needed""" 332 app.connect("builder-inited", generate_doxygen_xml) |
|