Adafruit_MicroPython_MAX31685/docs/conf.py

180 lines
5.3 KiB
Python
Raw Normal View History

2017-12-01 10:38:25 +01:00
# -*- coding: utf-8 -*-
import os
import sys
2020-03-15 23:41:20 +01:00
sys.path.insert(0, os.path.abspath(".."))
2017-12-01 10:38:25 +01:00
# -- General configuration ------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
2020-03-15 23:41:20 +01:00
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
2017-12-01 10:38:25 +01:00
]
2018-02-16 17:11:42 +01:00
# Uncomment the below if you use native CircuitPython modules such as
# digitalio, micropython and busio. List the modules you use. Without it, the
# autodoc module docs will fail to generate with a warning.
2018-08-05 22:46:09 +02:00
# autodoc_mock_imports = ["micropython", "adafruit_bus_device"]
2018-02-16 17:11:42 +01:00
2020-03-15 23:41:20 +01:00
intersphinx_mapping = {
"python": ("https://docs.python.org/3.4", None),
"BusDevice": (
"https://circuitpython.readthedocs.io/projects/busdevice/en/latest/",
None,
),
"CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
}
2017-12-01 10:38:25 +01:00
# Add any paths that contain templates here, relative to this directory.
2020-03-15 23:41:20 +01:00
templates_path = ["_templates"]
2017-12-01 10:38:25 +01:00
2020-03-15 23:41:20 +01:00
source_suffix = ".rst"
2017-12-01 10:38:25 +01:00
# The master toctree document.
2020-03-15 23:41:20 +01:00
master_doc = "index"
2017-12-01 10:38:25 +01:00
# General information about the project.
2020-03-15 23:41:20 +01:00
project = u"Adafruit MAX31865 Library"
copyright = u"2017 Tony DiCola"
author = u"Tony DiCola"
2017-12-01 10:38:25 +01:00
# 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.
2020-03-15 23:41:20 +01:00
version = u"1.0"
2017-12-01 10:38:25 +01:00
# The full version, including alpha/beta/rc tags.
2020-03-15 23:41:20 +01:00
release = u"1.0"
2017-12-01 10:38:25 +01:00
# 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 = None
# 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
2020-03-15 23:41:20 +01:00
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]
2017-12-01 10:38:25 +01:00
# The reST default role (used for this markup: `text`) to use for all
# documents.
#
default_role = "any"
# 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.
2020-03-15 23:41:20 +01:00
pygments_style = "sphinx"
2017-12-01 10:38:25 +01:00
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
2018-03-02 03:41:57 +01:00
# If this is True, todo emits a warning for each TODO entries. The default is False.
todo_emit_warnings = True
2017-12-01 10:38:25 +01:00
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
2020-03-15 23:41:20 +01:00
on_rtd = os.environ.get("READTHEDOCS", None) == "True"
2017-12-01 10:38:25 +01:00
if not on_rtd: # only import and set the theme if we're building docs locally
try:
import sphinx_rtd_theme
2020-03-15 23:41:20 +01:00
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
2017-12-01 10:38:25 +01:00
except:
2020-03-15 23:41:20 +01:00
html_theme = "default"
html_theme_path = ["."]
2017-12-01 10:38:25 +01:00
else:
2020-03-15 23:41:20 +01:00
html_theme_path = ["."]
2017-12-01 10:38:25 +01:00
# 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".
2020-03-15 23:41:20 +01:00
html_static_path = ["_static"]
2017-12-01 10:38:25 +01:00
2018-03-02 03:41:57 +01:00
# The name of an image file (relative to this directory) to use as a favicon of
# the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
#
2020-03-15 23:41:20 +01:00
html_favicon = "_static/favicon.ico"
2018-03-02 03:41:57 +01:00
2017-12-01 10:38:25 +01:00
# Output file base name for HTML help builder.
2020-03-15 23:41:20 +01:00
htmlhelp_basename = "AdafruitMAX31865Librarydoc"
2017-12-01 10:38:25 +01:00
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
2020-03-15 23:41:20 +01:00
# 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',
2017-12-01 10:38:25 +01:00
}
# 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 = [
2020-03-15 23:41:20 +01:00
(
master_doc,
"AdafruitMAX31865Library.tex",
u"Adafruit MAX31865 Library Documentation",
author,
"manual",
),
2017-12-01 10:38:25 +01:00
]
# -- Options for manual page output ---------------------------------------
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
2020-03-15 23:41:20 +01:00
(
master_doc,
"adafruitMAX31865library",
u"Adafruit MAX31865 Library Documentation",
[author],
1,
)
2017-12-01 10:38:25 +01:00
]
# -- 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 = [
2020-03-15 23:41:20 +01:00
(
master_doc,
"AdafruitMAX31865Library",
u"Adafruit MAX31865 Library Documentation",
author,
"AdafruitMAX31865Library",
"One line description of project.",
"Miscellaneous",
),
2017-12-01 10:38:25 +01:00
]