conf.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# pythonista documentation build configuration file, created by
# sphinx-quickstart on Sat Apr 22 16:07:08 2017.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

# 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))


# -- 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.
extensions = ['IPython.sphinxext.ipython_directive',
 'IPython.sphinxext.ipython_console_highlighting',
 'sphinx.ext.mathjax',
 'sphinx.ext.autodoc',
 'sphinx.ext.doctest',
 'sphinx.ext.inheritance_diagram',
 ]

try:
 import sphinx.util.compat
except ImportError:
 import sys
 import types
 import sphinx.util
 import docutils.parsers.rst
 class compat(types.ModuleType):
 Directive = docutils.parsers.rst.Directive
 sphinx.util.compat = compat('sphinx.util.compat')
 sys.modules['sphinx.util.compat'] = sphinx.util.compat

# Determine if the matplotlib has a recent enough version of the
# plot_directive, otherwise use the local fork.
try:
 from matplotlib.sphinxext import plot_directive
except ImportError:
 use_matplotlib_plot_directive = False
else:
 try:
 use_matplotlib_plot_directive = (plot_directive.__version__ >= 2)
 except AttributeError:
 use_matplotlib_plot_directive = False

if use_matplotlib_plot_directive:
 extensions.append('matplotlib.sphinxext.plot_directive')
else:
 extensions.append('plot_directive')

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = 'pythonista'
copyright = '2017, Purakaku Python-tutorial editorial committee'
author = 'Purakaku Python-tutorial editorial committee'

# 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.
#
# The short X.Y version.
version = ''
# The full version, including alpha/beta/rc tags.
release = ''
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#
# This is also used if you do content translation via gettext catalogs.
# Usually you set "language" from the command line for these cases.
language = 'ja'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This patterns also effect to html_static_path and html_extra_path
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False

numfig = True

# -- 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 = 'alabaster'

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
# html_theme_options = {}

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']

# Sometimes the savefig directory doesn't exist and needs to be created
# https://github.com/ipython/ipython/issues/8733
# becomes obsolete when ipython 5.2 is out
import os
ipython_savefig_dir = os.path.join(os.path.dirname(os.path.abspath(__file__)),
 '_build','html','_static')
if not os.path.exists(ipython_savefig_dir):
 os.makedirs(ipython_savefig_dir)

# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'You\'re one of Pythonistas from today'


# -- Options for LaTeX output ---------------------------------------------

language = 'ja'

latex_elements = {
 'releasename': '',
 'papersize': 'a4paper',
 'fontpkg': '',
 'fncychap': '',
 'preamble': '''
\\renewcommand{\\baselinestretch}{0.8}
\\pagestyle{plain}
\\thispagestyle{plain}
\\setcounter{secnumdepth}{3}

\\makeatother

\\let\\pyOldTableofcontents=\\tableofcontents
\\renewcommand{\\tableofcontents}{
 \\begingroup
 \\parskip = 0mm
 \\pyOldTableofcontents
 \\endgroup
 \\vspace{12pt}
}
''',
}

latex_docclass = {
 'howto': 'jsarticle',
 'manual': 'jsbook',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
 (master_doc, 'Pythonistas.tex',
 '今日からはじめるPython \\\\ You\'re one of Pythonistas from today',
 '今日から始めるPython 編集委員会', 'manual'),
]


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
 (master_doc, 'You\'re one of Pythonistas from today', '',
 [author], 1)
]

# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
 (master_doc, '今日から始めるPython', '',
 author, '今日から始めるPython', '',
 'Miscellaneous'),
]