#!/usr/bin/env python3

# -*- coding: utf-8 -*-

#

# MicroPython documentation build configuration file, created by

# sphinx-quickstart on Sun Sep 21 11:42:03 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.

import sys

import os

# 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.

sys.path.insert(0, os.path.abspath("."))

# The MICROPY_VERSION env var should be "vX.Y.Z" (or unset).

micropy_version = os.getenv("MICROPY_VERSION") or "latest"

micropy_all_versions = (os.getenv("MICROPY_ALL_VERSIONS") or "latest").split(",")

url_pattern = "%s/en/%%s" % (os.getenv("MICROPY_URL_PREFIX") or "/",)

# The members of the html_context dict are available inside topindex.html

html_context = {

"cur_version": micropy_version,

"all_versions": [(ver, url_pattern % ver) for ver in micropy_all_versions],

"downloads": [

("PDF", url_pattern % micropy_version + "/micropython-docs.pdf"),

],

"is_release": micropy_version != "latest",

}

# Authors used in various parts of the documentation.

micropy_authors = "MicroPython authors and contributors"

# -- 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 = [

"sphinx.ext.autodoc",

"sphinx.ext.doctest",

"sphinx.ext.intersphinx",

"sphinx.ext.todo",

"sphinx.ext.coverage",

"sphinxcontrib.jquery",

"sphinx_rtd_theme",

]

# Add any paths that contain templates here, relative to this directory.

templates_path = ["templates"]

# The suffix of source filenames.

source_suffix = ".rst"

# The encoding of source files.

# source_encoding = 'utf-8-sig'

# The master toctree document.

master_doc = "index"

# General information about the project.

project = "MicroPython"

copyright = "- The MicroPython Documentation is Copyright © 2014-2026, " + micropy_authors

# 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.

#

# We don't follow "The short X.Y version" vs "The full version, including alpha/beta/rc tags"

# breakdown, so use the same version identifier for both to avoid confusion.

version = release = micropy_version

# The language for content autogenerated by Sphinx. Refer to documentation

# for a list of supported languages.

# language = None

# There are two options for replacing |today|: either, you set today to some

# non-false value, then it is used:

# today = ''

# Else, today_fmt is used as the format for a strftime call.

# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and

# directories to ignore when looking for source files.

exclude_patterns = ["build", ".venv"]

# 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

# If true, the current module name will be prepended to all description

# unit titles (such as .. function::).

# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the

# output. They are ignored by default.

# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.

pygments_style = "sphinx"

# A list of ignored prefixes for module index sorting.

# modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.

# keep_warnings = False

# Global include files. Sphinx docs suggest using rst_epilog in preference

# of rst_prolog, so we follow. Absolute paths below mean "from the base

# of the doctree".

rst_epilog = """

.. include:: /templates/replace.inc

"""

# -- Options for HTML output ----------------------------------------------

import sphinx_rtd_theme

html_theme = "sphinx_rtd_theme"

# 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 themes here, relative to this directory.

# html_theme_path = ['.']

# The name for this set of Sphinx documents. If None, it defaults to

# "<project> v<release> documentation".

# html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.

# html_short_title = None

# The name of an image file (relative to this directory) to place at the top

# of the sidebar.

# html_logo = '../../logo/trans-logo.png'

# The name of an image file (within the static path) to use as favicon of the

# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32

# pixels large.

html_favicon = "static/favicon.ico"

# 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"]

# Add a custom CSS file for HTML generation

html_css_files = [

"custom.css",

]

# Add any extra paths that contain custom files (such as robots.txt or

# .htaccess) here, relative to this directory. These files are copied

# directly to the root of the documentation.

# html_extra_path = []

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,

# using the given strftime format.

html_last_updated_fmt = "%d %b %Y"

# 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 = {"index": "topindex.html"}

# If false, no module index is generated.

# html_domain_indices = True

# 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 = "MicroPythondoc"

# -- 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': '',

# Include 3 levels of headers in PDF ToC

"preamble": r"\setcounter{tocdepth}{2}",

}

# 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,

"MicroPython.tex",

"MicroPython Documentation",

micropy_authors,

"manual",

),

]

# The name of an image file (relative to this directory) to place at the top of

# the title page.

# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,

# not chapters.

# latex_use_parts = False

# If true, show page references after internal links.

# latex_show_pagerefs = False

# If true, show URL addresses after external links.

# latex_show_urls = False

# Documents to append as an appendix to all manuals.

# latex_appendices = []

# If false, no module index is generated.

# latex_domain_indices = True

# Enable better Unicode support so that `make latexpdf` doesn't fail

latex_engine = "xelatex"

# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples

# (source start file, name, description, authors, manual section).

man_pages = [

(

"index",

"micropython",

"MicroPython Documentation",

[micropy_authors],

1,

),

]

# If true, show URL addresses after external links.

# man_show_urls = False

# -- 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,

"MicroPython",

"MicroPython Documentation",

micropy_authors,

"MicroPython",

"One line description of project.",

"Miscellaneous",

),

]

# Documents to append as an appendix to all manuals.

# texinfo_appendices = []

# If false, no module index is generated.

# texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.

# texinfo_show_urls = 'footnote'

# If true, do not generate a @detailmenu in the "Top" node's menu.

# texinfo_no_detailmenu = False

# Example configuration for intersphinx: refer to the Python standard library.

intersphinx_mapping = {"python": ("https://docs.python.org/3.5", None)}