Last active
February 11, 2017 00:53
-
-
Save pashango2/399010efaa546a47db5c82c72e4f3b5e to your computer and use it in GitHub Desktop.
Sphinx1.5.2 templates
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
{% if PY3 -%} | |
#!/usr/bin/env python3 | |
{% endif -%} | |
# -*- coding: utf-8 -*- | |
# | |
# {{ project }} documentation build configuration file, created by | |
# sphinx-quickstart on {{ now }}. | |
# | |
# 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. | |
# | |
{% if append_syspath -%} | |
import os | |
import sys | |
sys.path.insert(0, u'{{ module_path }}') | |
{% else -%} | |
# import os | |
# import sys | |
{% if module_path -%} | |
# sys.path.insert(0, u'{{ module_path }}') | |
{% else -%} | |
# sys.path.insert(0, os.path.abspath('.')) | |
{% endif -%} | |
{% endif %} | |
# -- 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 = [{{ extensions }}] | |
# Add any paths that contain templates here, relative to this directory. | |
templates_path = ['{{ dot }}templates'] | |
# The suffix(es) of source filenames. | |
# You can specify multiple suffix as a list of string: | |
# | |
source_suffix = ['.rst', '.md'] | |
# source_suffix = '{{ suffix }}' | |
from recommonmark.parser import CommonMarkParser | |
source_parsers = { | |
'.md': CommonMarkParser, | |
} | |
# The master toctree document. | |
master_doc = '{{ master_str }}' | |
# General information about the project. | |
project = u'{{ project_str }}' | |
copyright = u'{{ copyright_str }}' | |
author = u'{{ author_str }}' | |
# 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 = u'{{ version_str }}' | |
# The full version, including alpha/beta/rc tags. | |
release = u'{{ release_str }}' | |
# 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 = {{ language | repr }} | |
# 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 = [{{ 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 = {{ ext_todo }} | |
# -- Options for HTML output ---------------------------------------------- | |
# The theme to use for HTML and HTML Help pages. See the documentation for | |
# a list of builtin themes. | |
# | |
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 = ['{{ dot }}static'] | |
# -- Options for HTMLHelp output ------------------------------------------ | |
# Output file base name for HTML help builder. | |
htmlhelp_basename = '{{ project_fn }}doc' | |
# -- Options for LaTeX output --------------------------------------------- | |
latex_elements = { | |
# The paper size ('letterpaper' or 'a4paper'). | |
# | |
# 'papersize': 'letterpaper', | |
# The font size ('10pt', '11pt' or '12pt'). | |
# | |
# 'pointsize': '10pt', | |
# Additional stuff for the LaTeX preamble. | |
# | |
# 'preamble': '', | |
# Latex figure (float) alignment | |
# | |
# 'figure_align': 'htbp', | |
} | |
# 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, '{{ project_fn }}.tex', u'{{ project_doc_texescaped_str }}', | |
u'{{ author_texescaped_str }}', '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, '{{ project_manpage }}', u'{{ project_doc_str }}', | |
[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, '{{ project_fn }}', u'{{ project_doc_str }}', | |
author, '{{ project_fn }}', 'One line description of project.', | |
'Miscellaneous'), | |
] | |
{% if epub %} | |
# -- Options for Epub output ---------------------------------------------- | |
# Bibliographic Dublin Core info. | |
epub_title = project | |
epub_author = author | |
epub_publisher = author | |
epub_copyright = copyright | |
# The unique identifier of the text. This can be a ISBN number | |
# or the project homepage. | |
# | |
# epub_identifier = '' | |
# A unique identification for the text. | |
# | |
# epub_uid = '' | |
# A list of files that should not be packed into the epub file. | |
epub_exclude_files = ['search.html'] | |
{% endif %} | |
{% if ext_intersphinx %} | |
# Example configuration for intersphinx: refer to the Python standard library. | |
intersphinx_mapping = {'https://docs.python.org/': None} | |
{% endif %} | |
from recommonmark.transform import AutoStructify | |
github_doc_root = 'https://github.com/rtfd/recommonmark/tree/master/doc/' | |
def setup(app): | |
app.add_config_value('recommonmark_config', { | |
'url_resolver': lambda url: github_doc_root + url, | |
'auto_toc_tree_section': 'Contents', | |
}, True) | |
app.add_transform(AutoStructify) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Minimal makefile for Sphinx documentation | |
# | |
# You can set these variables from the command line. | |
SPHINXOPTS = | |
SPHINXBUILD = sphinx-build | |
SPHINXPROJ = {{ project_fn }} | |
SOURCEDIR = {{ rsrcdir }} | |
BUILDDIR = {{ rbuilddir }} | |
# Put it first so that "make" without argument is like "make help". | |
help: | |
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | |
.PHONY: help Makefile | |
# Catch-all target: route all unknown targets to Sphinx using the new | |
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). | |
%: Makefile | |
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) | |
livehtml: | |
sphinx-autobuild -b html $(SOURCEDIR) $(BUILDDIR)/html |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Makefile for Sphinx documentation | |
# | |
# You can set these variables from the command line. | |
SPHINXOPTS = | |
SPHINXBUILD = sphinx-build | |
PAPER = | |
BUILDDIR = {{ rbuilddir }} | |
# Internal variables. | |
PAPEROPT_a4 = -D latex_elements.papersize=a4 | |
PAPEROPT_letter = -D latex_elements.papersize=letter | |
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) {{ rsrcdir }} | |
# the i18n builder cannot share the environment and doctrees with the others | |
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) {{ rsrcdir }} | |
.PHONY: help | |
help: | |
@echo "Please use \`make <target>' where <target> is one of" | |
@echo " html to make standalone HTML files" | |
@echo " dirhtml to make HTML files named index.html in directories" | |
@echo " singlehtml to make a single large HTML file" | |
@echo " pickle to make pickle files" | |
@echo " json to make JSON files" | |
@echo " htmlhelp to make HTML files and an HTML help project" | |
@echo " qthelp to make HTML files and a qthelp project" | |
@echo " applehelp to make an Apple Help Book" | |
@echo " devhelp to make HTML files and a Devhelp project" | |
@echo " epub to make an epub" | |
@echo " epub3 to make an epub3" | |
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" | |
@echo " latexpdf to make LaTeX files and run them through pdflatex" | |
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" | |
@echo " lualatexpdf to make LaTeX files and run them through lualatex" | |
@echo " xelatexpdf to make LaTeX files and run them through xelatex" | |
@echo " text to make text files" | |
@echo " man to make manual pages" | |
@echo " texinfo to make Texinfo files" | |
@echo " info to make Texinfo files and run them through makeinfo" | |
@echo " gettext to make PO message catalogs" | |
@echo " changes to make an overview of all changed/added/deprecated items" | |
@echo " xml to make Docutils-native XML files" | |
@echo " pseudoxml to make pseudoxml-XML files for display purposes" | |
@echo " linkcheck to check all external links for integrity" | |
@echo " doctest to run all doctests embedded in the documentation (if enabled)" | |
@echo " coverage to run coverage check of the documentation (if enabled)" | |
@echo " dummy to check syntax errors of document sources" | |
.PHONY: clean | |
clean: | |
rm -rf $(BUILDDIR)/* | |
.PHONY: html | |
html: | |
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | |
@echo | |
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html." | |
.PHONY: dirhtml | |
dirhtml: | |
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml | |
@echo | |
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." | |
.PHONY: singlehtml | |
singlehtml: | |
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml | |
@echo | |
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." | |
.PHONY: pickle | |
pickle: | |
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle | |
@echo | |
@echo "Build finished; now you can process the pickle files." | |
.PHONY: json | |
json: | |
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json | |
@echo | |
@echo "Build finished; now you can process the JSON files." | |
.PHONY: htmlhelp | |
htmlhelp: | |
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp | |
@echo | |
@echo "Build finished; now you can run HTML Help Workshop with the" \ | |
".hhp project file in $(BUILDDIR)/htmlhelp." | |
.PHONY: qthelp | |
qthelp: | |
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp | |
@echo | |
@echo "Build finished; now you can run "qcollectiongenerator" with the" \ | |
".qhcp project file in $(BUILDDIR)/qthelp, like this:" | |
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/{{ project_fn }}.qhcp" | |
@echo "To view the help file:" | |
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/{{ project_fn }}.qhc" | |
.PHONY: applehelp | |
applehelp: | |
$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp | |
@echo | |
@echo "Build finished. The help book is in $(BUILDDIR)/applehelp." | |
@echo "N.B. You won't be able to view it unless you put it in" \ | |
"~/Library/Documentation/Help or install it in your application" \ | |
"bundle." | |
.PHONY: devhelp | |
devhelp: | |
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp | |
@echo | |
@echo "Build finished." | |
@echo "To view the help file:" | |
@echo "# mkdir -p $$HOME/.local/share/devhelp/{{ project_fn }}" | |
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/{{ project_fn }}" | |
@echo "# devhelp" | |
.PHONY: epub | |
epub: | |
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub | |
@echo | |
@echo "Build finished. The epub file is in $(BUILDDIR)/epub." | |
.PHONY: epub3 | |
epub3: | |
$(SPHINXBUILD) -b epub3 $(ALLSPHINXOPTS) $(BUILDDIR)/epub3 | |
@echo | |
@echo "Build finished. The epub3 file is in $(BUILDDIR)/epub3." | |
.PHONY: latex | |
latex: | |
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | |
@echo | |
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." | |
@echo "Run \`make' in that directory to run these through (pdf)latex" \ | |
"(use \`make latexpdf' here to do that automatically)." | |
.PHONY: latexpdf | |
latexpdf: | |
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | |
@echo "Running LaTeX files through pdflatex..." | |
$(MAKE) -C $(BUILDDIR)/latex all-pdf | |
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." | |
.PHONY: latexpdfja | |
latexpdfja: | |
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | |
@echo "Running LaTeX files through platex and dvipdfmx..." | |
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja | |
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." | |
.PHONY: lualatexpdf | |
lualatexpdf: | |
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | |
@echo "Running LaTeX files through lualatex..." | |
$(MAKE) PDFLATEX=lualatex -C $(BUILDDIR)/latex all-pdf | |
@echo "lualatex finished; the PDF files are in $(BUILDDIR)/latex." | |
.PHONY: xelatexpdf | |
xelatexpdf: | |
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex | |
@echo "Running LaTeX files through xelatex..." | |
$(MAKE) PDFLATEX=xelatex -C $(BUILDDIR)/latex all-pdf | |
@echo "xelatex finished; the PDF files are in $(BUILDDIR)/latex." | |
.PHONY: text | |
text: | |
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text | |
@echo | |
@echo "Build finished. The text files are in $(BUILDDIR)/text." | |
.PHONY: man | |
man: | |
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man | |
@echo | |
@echo "Build finished. The manual pages are in $(BUILDDIR)/man." | |
.PHONY: texinfo | |
texinfo: | |
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | |
@echo | |
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." | |
@echo "Run \`make' in that directory to run these through makeinfo" \ | |
"(use \`make info' here to do that automatically)." | |
.PHONY: info | |
info: | |
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo | |
@echo "Running Texinfo files through makeinfo..." | |
make -C $(BUILDDIR)/texinfo info | |
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." | |
.PHONY: gettext | |
gettext: | |
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale | |
@echo | |
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." | |
.PHONY: changes | |
changes: | |
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes | |
@echo | |
@echo "The overview file is in $(BUILDDIR)/changes." | |
.PHONY: linkcheck | |
linkcheck: | |
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck | |
@echo | |
@echo "Link check complete; look for any errors in the above output " \ | |
"or in $(BUILDDIR)/linkcheck/output.txt." | |
.PHONY: doctest | |
doctest: | |
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest | |
@echo "Testing of doctests in the sources finished, look at the " \ | |
"results in $(BUILDDIR)/doctest/output.txt." | |
.PHONY: coverage | |
coverage: | |
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage | |
@echo "Testing of coverage in the sources finished, look at the " \ | |
"results in $(BUILDDIR)/coverage/python.txt." | |
.PHONY: xml | |
xml: | |
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml | |
@echo | |
@echo "Build finished. The XML files are in $(BUILDDIR)/xml." | |
.PHONY: pseudoxml | |
pseudoxml: | |
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml | |
@echo | |
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." | |
.PHONY: dummy | |
dummy: | |
$(SPHINXBUILD) -b dummy $(ALLSPHINXOPTS) $(BUILDDIR)/dummy | |
@echo | |
@echo "Build finished. Dummy builder generates no files." | |
livehtml: | |
sphinx-autobuild -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment