mirror of
https://github.com/m5stack/m5-docs.git
synced 2026-05-20 10:23:01 -07:00
144 lines
4.3 KiB
Python
144 lines
4.3 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# English Languag`e RTD & Sphinx config file
|
|
#
|
|
# Uses ../conf_common.py for most non-language-specific settings.
|
|
|
|
# Importing conf_common adds all the non-language-specific
|
|
# parts to this conf module
|
|
# import sys, os
|
|
# sys.path.insert(0, os.path.abspath('..'))
|
|
# from conf_common import *
|
|
|
|
# General information about the project.
|
|
project = u'M5Stack'
|
|
copyright = u'2017 - 2018, M5Stack Inc'
|
|
author = u'M5Stack'
|
|
|
|
# The short X.Y version
|
|
version = u''
|
|
# The full version, including alpha/beta/rc tags
|
|
release = u'1.0.1'
|
|
|
|
# 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'
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
language = 'en'
|
|
|
|
# The name of the Pygments (syntax highlighting) style to use.
|
|
pygments_style = 'sphinx'
|
|
# pygments_style = None
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
# exclude_patterns = [u'../en_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
# -- 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 = ['_static']
|
|
html_static_path = ['_static/M5Stack_MicroPython_UserGuidePictures']
|
|
|
|
# Custom sidebar templates, must be a dictionary that maps document names
|
|
# to template names.
|
|
#
|
|
# The default sidebars (for documents that don't match any pattern) are
|
|
# defined by theme itself. Builtin themes are using these templates by
|
|
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
|
|
# 'searchbox.html']``.
|
|
#
|
|
# html_sidebars = {}
|
|
|
|
|
|
# -- Options for HTMLHelp output ---------------------------------------------
|
|
|
|
# Output file base name for HTML help builder.
|
|
htmlhelp_basename = 'M5Stackdoc'
|
|
|
|
|
|
# -- 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, 'M5Stack.tex', u'M5Stack Documentation',
|
|
u'M5Stack', '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, 'm5stack', u'M5Stack Documentation',
|
|
[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, 'M5Stack', u'M5Stack Documentation',
|
|
author, 'M5Stack', 'One line description of project.',
|
|
'Miscellaneous'),
|
|
]
|
|
|
|
# -- AutoStructify Setting ----------------------------------------------
|
|
|
|
# At top on conf.py (with other import statements)
|
|
# import recommonmark
|
|
# from recommonmark.transform import AutoStructify
|
|
|
|
# At the bottom of conf.py
|
|
# 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) |