# Colored terminal output for Python's logging module.

#

# Author: Peter Odding <peter@peterodding.com>

# Last Change: May 18, 2017

# URL: https://coloredlogs.readthedocs.io

"""Sphinx documentation configuration for the `coloredlogs` package."""

import os

import sys

# Add the 'coloredlogs' source distribution's root directory to the module path.

sys.path.insert(0, os.path.abspath(os.pardir))

# -- General configuration -----------------------------------------------------

# Sphinx extension module names.

extensions = [

'sphinx.ext.autodoc',

'sphinx.ext.intersphinx',

'sphinx.ext.viewcode',

'humanfriendly.sphinx',

]

# Sort members by the source order instead of alphabetically.

autodoc_member_order = 'bysource'

# Paths that contain templates, relative to this directory.

templates_path = ['templates']

# The suffix of source filenames.

source_suffix = '.rst'

# The master toctree document.

master_doc = 'index'

# General information about the project.

project = u'coloredlogs'

copyright = u'2017, Peter Odding'

# The version info for the project you're documenting, acts as replacement for

# |version| and |release|, also used in various other places throughout the

# built documents.

# Find the package version and make it the release.

from coloredlogs import __version__ as coloredlogs_version # noqa

# The short X.Y version.

version = '.'.join(coloredlogs_version.split('.')[:2])

# The full version, including alpha/beta/rc tags.

release = coloredlogs_version

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

language = 'en'

# List of patterns, relative to source directory, that match files and

# directories to ignore when looking for source files.

exclude_patterns = ['build']

# If true, '()' will be appended to :func: etc. cross-reference text.

add_function_parentheses = True

# The name of the Pygments (syntax highlighting) style to use.

pygments_style = 'sphinx'

# Refer to the Python standard library.

# From: http://twistedmatrix.com/trac/ticket/4582.

intersphinx_mapping = dict(

python=('https://docs.python.org/2', None),

capturer=('https://capturer.readthedocs.io/en/latest', None),

humanfriendly=('https://humanfriendly.readthedocs.io/en/latest', None),

)

# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for

# a list of builtin themes.

html_theme = 'nature'

# Output file base name for HTML help builder.

htmlhelp_basename = 'coloredlogsdoc'