227 lines
7.4 KiB
Python
227 lines
7.4 KiB
Python
# -*- coding: utf-8 -*-
|
||
#
|
||
# 跟我一起写Makefile documentation build configuration file, created by
|
||
# sphinx-quickstart on Tue Feb 25 20:24:37 2014.
|
||
#
|
||
# 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.5'
|
||
|
||
# Add any Sphinx extension module names here, as strings. They can be
|
||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||
# ones.
|
||
extensions = ['sphinx.ext.todo',
|
||
'sphinx.ext.viewcode',
|
||
'sphinx.ext.githubpages']
|
||
|
||
# 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 = u'跟我一起写Makefile'
|
||
copyright = u'2014-2017, 作者：陈皓；排版：SeisMan'
|
||
author = 'SeisMan'
|
||
|
||
# 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 = '1.0'
|
||
# The full version, including alpha/beta/rc tags.
|
||
release = '1.0'
|
||
|
||
# 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 = 'zh_CN'
|
||
|
||
# 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 = []
|
||
|
||
# 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 = True
|
||
|
||
|
||
# -- Options for HTML output ----------------------------------------------
|
||
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
|
||
|
||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||
# a list of builtin themes.
|
||
if on_rtd:
|
||
html_theme = 'default'
|
||
else:
|
||
import sphinx_rtd_theme
|
||
html_theme = 'sphinx_rtd_theme'
|
||
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
||
|
||
# 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']
|
||
|
||
|
||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
||
# using the given strftime format.
|
||
html_last_updated_fmt = '%x'
|
||
|
||
# If true, SmartyPants will be used to convert quotes and dashes to
|
||
# typographically correct entities.
|
||
#html_use_smartypants = True
|
||
|
||
# Custom sidebar templates, maps document names to template names.
|
||
#html_sidebars = {}
|
||
|
||
# Additional templates that should be rendered to pages, maps page names to
|
||
# template names.
|
||
#html_additional_pages = {}
|
||
|
||
# If false, no module index is generated.
|
||
html_domain_indices = False
|
||
|
||
# If false, no index is generated.
|
||
html_use_index = True
|
||
|
||
# If true, the index is split into individual pages for each letter.
|
||
html_split_index = False
|
||
|
||
# If true, links to the reST sources are added to the pages.
|
||
html_show_sourcelink = True
|
||
|
||
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
|
||
#html_show_sphinx = True
|
||
|
||
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
|
||
# html_show_copyright = True
|
||
|
||
# If true, an OpenSearch description file will be output, and all pages will
|
||
# contain a <link> tag referring to it. The value of this option must be the
|
||
# base URL from which the finished HTML is served.
|
||
#html_use_opensearch = ''
|
||
|
||
# This is the file name suffix for HTML files (e.g. ".xhtml").
|
||
#html_file_suffix = None
|
||
|
||
# Output file base name for HTML help builder.
|
||
htmlhelp_basename = 'Makefiledoc'
|
||
|
||
|
||
# -- Options for LaTeX output ---------------------------------------------
|
||
|
||
if on_rtd:
|
||
latex_elements = {
|
||
# The paper size ('letterpaper' or 'a4paper').
|
||
'papersize': 'a4paper',
|
||
|
||
# The font size ('10pt', '11pt' or '12pt').
|
||
'pointsize': '11pt',
|
||
|
||
# Additional stuff for the LaTeX preamble.
|
||
'preamble': r'''
|
||
\hypersetup{unicode=true}
|
||
\usepackage{CJKutf8}
|
||
\DeclareUnicodeCharacter{00A0}{\nobreakspace}
|
||
\DeclareUnicodeCharacter{2203}{\ensuremath{\exists}}
|
||
\DeclareUnicodeCharacter{2200}{\ensuremath{\forall}}
|
||
\DeclareUnicodeCharacter{2286}{\ensuremath{\subseteq}}
|
||
\DeclareUnicodeCharacter{2713}{x}
|
||
\DeclareUnicodeCharacter{27FA}{\ensuremath{\Longleftrightarrow}}
|
||
\DeclareUnicodeCharacter{221A}{\ensuremath{\sqrt{}}}
|
||
\DeclareUnicodeCharacter{221B}{\ensuremath{\sqrt[3]{}}}
|
||
\DeclareUnicodeCharacter{2295}{\ensuremath{\oplus}}
|
||
\DeclareUnicodeCharacter{2297}{\ensuremath{\otimes}}
|
||
\begin{CJK}{UTF8}{gbsn}
|
||
\AtEndDocument{\end{CJK}}
|
||
''',
|
||
}
|
||
else:
|
||
latex_elements = {
|
||
'papersize' : 'a4paper',
|
||
'utf8extra' : '',
|
||
'inputenc' : '',
|
||
'cmappkg' : '',
|
||
'fontenc' : '',
|
||
'releasename' : 'By SeisMan@GitHub',
|
||
'release' : '',
|
||
'babel' : r'''\usepackage[english]{babel}''',
|
||
'preamble' : r'''
|
||
\usepackage{ctex}
|
||
\parindent 2em
|
||
\setcounter{tocdepth}{3}
|
||
\renewcommand\familydefault{\ttdefault}
|
||
\renewcommand\CJKfamilydefault{\CJKrmdefault}
|
||
''',
|
||
}
|
||
|
||
# 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, 'Makefile.tex',
|
||
u'跟我一起写Makefile (PDF重制版)',
|
||
u'作者: 陈皓', 'manual', True),
|
||
]
|
||
|
||
# -- 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, 'makefile', u'跟我一起写Makefile',
|
||
[u'陈皓'], 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, 'Makefile', u'跟我一起写Makefile',
|
||
u'陈皓', 'Makefile', 'One line description of project.',
|
||
'Miscellaneous'),
|
||
]
|