conf Namespace Reference

Functions
def	get_libuv_version ()

Variables
list	extensions = ['manpage']
list	templates_path = ['templates']
string	source_suffix = '.rst'
string	master_doc = 'index'
string	project = u'libuv API documentation'
string	copyright = u'2014-present, libuv contributors'
def	version = get_libuv_version()
def	release = version
list	exclude_patterns = []
string	pygments_style = 'sphinx'
string	html_theme = 'nature'
string	html_title = 'libuv documentation'
string	html_short_title = 'libuv %s documentation' % version
string	html_logo = 'static/logo.png'
string	html_favicon = 'static/favicon.ico'
list	html_static_path = ['static']
string	htmlhelp_basename = 'libuv'
dictionary	latex_elements
list	latex_documents
list	man_pages
list	texinfo_documents
string	epub_title = u'libuv documentation'
string	epub_author = u'libuv contributors'
string	epub_publisher = u'libuv contributors'
string	epub_copyright = u'2014-present, libuv contributors'
string	epub_basename = u'libuv'
list	epub_exclude_files = ['search.html']

Function Documentation

get_libuv_version()

def conf.get_libuv_version

(

)

Definition at line 20 of file conf.py.

def get_libuv_version():
    with open('../../include/uv/version.h') as f:
        data = f.read()
    try:
        m = re.search(r"""^#define UV_VERSION_MAJOR (\d+)$""", data, re.MULTILINE)
        major = int(m.group(1))
        m = re.search(r"""^#define UV_VERSION_MINOR (\d+)$""", data, re.MULTILINE)
        minor = int(m.group(1))
        m = re.search(r"""^#define UV_VERSION_PATCH (\d+)$""", data, re.MULTILINE)
        patch = int(m.group(1))
        m = re.search(r"""^#define UV_VERSION_IS_RELEASE (\d)$""", data, re.MULTILINE)
        is_release = int(m.group(1))
        m = re.search(r"""^#define UV_VERSION_SUFFIX \"(\w*)\"$""", data, re.MULTILINE)
        suffix = m.group(1)
        return '%d.%d.%d%s' % (major, minor, patch, '-%s' % suffix if not is_release else '')
    except Exception:
        return 'unknown'
 
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, os.path.abspath('sphinx-plugins'))
 
# -- General configuration ------------------------------------------------
 
# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'
 
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.

References int.

Variable Documentation

copyright

string conf.copyright = u'2014-present, libuv contributors'

Definition at line 67 of file conf.py.

epub_author

string conf.epub_author = u'libuv contributors'

Definition at line 285 of file conf.py.

epub_basename

string conf.epub_basename = u'libuv'

Definition at line 290 of file conf.py.

epub_copyright

string conf.epub_copyright = u'2014-present, libuv contributors'

Definition at line 287 of file conf.py.

epub_exclude_files

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

Definition at line 327 of file conf.py.

epub_publisher

string conf.epub_publisher = u'libuv contributors'

Definition at line 286 of file conf.py.

epub_title

string conf.epub_title = u'libuv documentation'

Definition at line 284 of file conf.py.

exclude_patterns

list conf.exclude_patterns = []

Definition at line 90 of file conf.py.

extensions

list conf.extensions = ['manpage']

Definition at line 51 of file conf.py.

html_favicon

string conf.html_favicon = 'static/favicon.ico'

Definition at line 145 of file conf.py.

html_logo

string conf.html_logo = 'static/logo.png'

Definition at line 140 of file conf.py.

html_short_title

string conf.html_short_title = 'libuv %s documentation' % version

Definition at line 136 of file conf.py.

html_static_path

list conf.html_static_path = ['static']

Definition at line 150 of file conf.py.

html_theme

string conf.html_theme = 'nature'

Definition at line 121 of file conf.py.

html_title

string conf.html_title = 'libuv documentation'

Definition at line 133 of file conf.py.

htmlhelp_basename

string conf.htmlhelp_basename = 'libuv'

Definition at line 199 of file conf.py.

latex_documents

list conf.latex_documents

Initial value:

=  [
  ('index', 'libuv.tex', u'libuv documentation',
   u'libuv contributors', 'manual'),
]

Definition at line 218 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.
#'preamble': '',
}

Definition at line 204 of file conf.py.

man_pages

list conf.man_pages

Initial value:

=  [
    ('index', 'libuv', u'libuv documentation',
     [u'libuv contributors'], 1)
]

Definition at line 248 of file conf.py.

master_doc

string conf.master_doc = 'index'

Definition at line 63 of file conf.py.

project

string conf.project = u'libuv API documentation'

Definition at line 66 of file conf.py.

pygments_style

string conf.pygments_style = 'sphinx'

Definition at line 108 of file conf.py.

release

def conf.release = version

Definition at line 76 of file conf.py.

source_suffix

string conf.source_suffix = '.rst'

Definition at line 57 of file conf.py.

templates_path

list conf.templates_path = ['templates']

Definition at line 54 of file conf.py.

texinfo_documents

list conf.texinfo_documents

Initial value:

=  [
  ('index', 'libuv', u'libuv documentation',
   u'libuv contributors', 'libuv', 'Cross-platform asynchronous I/O',
   'Miscellaneous'),
]

Definition at line 262 of file conf.py.

version

def conf.version = get_libuv_version()

Definition at line 74 of file conf.py.