esphome-docs/conf.py

228 lines
6.1 KiB
Python
Raw Normal View History

2018-05-13 11:37:02 +02:00
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
2019-02-16 23:25:23 +01:00
# esphome documentation build configuration file, created by
2018-05-13 11:37:02 +02:00
# sphinx-quickstart on Mon Jan 22 21:44:07 2018.
#
# 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('.'))
2019-03-11 19:59:52 +01:00
import hashlib
2018-05-13 11:37:02 +02:00
import os
2018-10-12 16:33:22 +02:00
import sys
2018-05-13 11:37:02 +02:00
sys.path.append(os.path.abspath("."))
2018-05-13 11:37:02 +02:00
# -- 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 = [
"github",
"seo",
2022-10-12 23:14:43 +02:00
"components",
2022-10-26 01:07:51 +02:00
"sitemap",
2018-05-13 11:37:02 +02:00
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
2018-05-13 11:37:02 +02:00
# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = ".rst"
2018-05-13 11:37:02 +02:00
# The master toctree document.
master_doc = "index"
2018-05-13 11:37:02 +02:00
# General information about the project.
project = "ESPHome"
2022-02-18 10:34:52 +01:00
copyright = "2022, Nabu Casa"
html_show_copyright = False
2018-12-31 13:17:43 +01:00
html_show_sphinx = False
2022-02-18 10:34:52 +01:00
author = "ESPHome"
2018-05-13 11:37:02 +02: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.
2024-05-08 03:22:05 +02:00
version = "2024.5"
2018-05-13 11:37:02 +02:00
# The full version, including alpha/beta/rc tags.
2024-05-27 22:29:21 +02:00
release = "2024.5.4"
2018-05-13 11:37:02 +02: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 = "en"
2018-05-13 11:37:02 +02:00
# 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
2022-02-16 19:35:48 +01:00
exclude_patterns = [
"_build",
"Thumbs.db",
".DS_Store",
"env",
"venv",
"ENV",
".venv",
".env",
]
2018-05-13 11:37:02 +02:00
html_extra_path = [
"_redirects",
]
2018-05-13 11:37:02 +02:00
# The reST default role (used for this markup: `text`) to use for all documents.
# default_role = 'cpp:any'
# The name of the Pygments (syntax highlighting) style to use.
2023-07-09 23:49:12 +02:00
# pygments_style = "xcode"
2018-05-13 11:37:02 +02:00
highlight_language = "yaml"
2018-05-13 11:37:02 +02:00
primary_domain = None
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
2023-07-09 23:49:12 +02:00
html_theme = "esphome"
html_theme_path = ["_themes"]
2018-05-13 11:37:02 +02:00
# 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_baseurl = os.getenv("BASE_URL", "https://esphome.io")
with open("_static/custom.css", "rb") as f:
2019-03-11 19:59:52 +01:00
custom_css_hash = hashlib.md5(f.read()).hexdigest()[:8]
2019-03-05 20:33:51 +01:00
2018-05-13 11:37:02 +02:00
html_theme_options = {
2018-09-23 19:00:31 +02:00
# 'logo': 'logo-full.png',
"logo_name": False,
"show_related": False,
"sidebar_collapse": True,
"fixed_sidebar": True,
"show_powered_by": False,
2018-05-13 11:37:02 +02:00
}
2019-03-05 20:33:51 +01:00
html_context = {
"custom_css_hash": custom_css_hash,
2019-03-05 20:33:51 +01:00
}
html_logo = "images/logo-text.svg"
2018-09-23 19:00:31 +02:00
html_copy_source = True
html_show_sourcelink = False
html_last_updated_fmt = None
html_use_smartypants = False
html_title = "ESPHome"
2018-09-23 19:00:31 +02:00
2018-05-13 11:37:02 +02: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".
html_static_path = ["_static"]
2018-05-13 11:37:02 +02:00
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#
# This is required for the alabaster theme
# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars
html_sidebars = {
"**": [
2018-09-23 19:00:31 +02:00
# 'about.html',
"searchbox.html",
"localtoc.html",
2021-07-26 23:42:47 +02:00
"contact.html",
2018-05-13 11:37:02 +02:00
]
}
2018-05-13 11:37:02 +02:00
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = "esphomedoc"
2018-05-13 11:37:02 +02:00
# -- 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 = [
2022-02-18 10:34:52 +01:00
(master_doc, "esphome.tex", "ESPHome Documentation", author, "manual"),
2018-05-13 11:37:02 +02:00
]
latex_engine = "xelatex"
2018-06-01 18:10:00 +02:00
2018-05-13 11:37:02 +02:00
# -- 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, "esphome", "ESPHome Documentation", [author], 1)]
2018-05-13 11:37:02 +02: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 = [
(
master_doc,
"esphome",
"ESPHome Documentation",
author,
"esphome",
"One line description of project.",
"Miscellaneous",
),
2018-05-13 11:37:02 +02:00
]
linkcheck_ignore = [r"https://github.com/.*", r"https://discord.gg/.*"]