Merge branch 'adafruit:main' into main

[Adafruit_Blinka-hackapet.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index baa9085a0dae967f3f7d8e45d094b3ede18d137b..0b0b04f87b2b6d7002044709c93ba677760c136f 100755 (executable)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,8 +1,13 @@
 # -*- coding: utf-8 -*-
 
 # -*- coding: utf-8 -*-
 

+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+

 import os
 import sys
 import os
 import sys

-sys.path.insert(0, os.path.abspath('../src'))
+
+sys.path.insert(0, os.path.abspath("../src"))

 
 # -- General configuration ------------------------------------------------
 
 
 # -- General configuration ------------------------------------------------
 


@@ -10,52 +15,61 @@ sys.path.insert(0, os.path.abspath('../src'))
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [

-    'sphinx.ext.autodoc',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo',
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",

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

-autodoc_mock_imports = ["machine", "Adafruit_GPIO"]
+autodoc_mock_imports = [
+    "machine",
+    "Adafruit_GPIO",
+    "RPi",
+    "RPi.GPIO",
+    "hid",
+    "sysv_ipc",
+]

 
 

-intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),
-                       'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3.7", None),
+    "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
+}

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

-templates_path = ['_templates']
+templates_path = ["_templates"]

 
 

-source_suffix = '.rst'
+source_suffix = ".rst"

 
 # The master toctree document.
 
 # The master toctree document.

-master_doc = 'index'
+master_doc = "index"

 
 # General information about the project.
 
 # General information about the project.

-project = u'Adafruit Blinka Library'
-copyright = u'2017 cefn'
-author = u'cefn'
+project = "Adafruit Blinka Library"
+copyright = "2017 cefn"
+author = "cefn"

 
 # 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.
 
 # 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'1.0.0'
+version = "1.0.0"

 # The full version, including alpha/beta/rc tags.
 # The full version, including alpha/beta/rc tags.

-release = u'1.0.0'
+release = "1.0.0"

 
 # 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.
 
 # 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
+language = "en"

 
 # 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
 
 # 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 = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"]

 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.


@@ -67,7 +81,7 @@ default_role = "any"
 add_function_parentheses = True
 
 # The name of the Pygments (syntax highlighting) style to use.
 add_function_parentheses = True
 
 # The name of the Pygments (syntax highlighting) style to use.

-pygments_style = 'sphinx'
+pygments_style = "sphinx"

 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False
 
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = False


@@ -81,53 +95,56 @@ todo_emit_warnings = True
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #

-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+on_rtd = os.environ.get("READTHEDOCS", None) == "True"

 
 if not on_rtd:  # only import and set the theme if we're building docs locally
     try:
         import sphinx_rtd_theme
 
 if not on_rtd:  # only import and set the theme if we're building docs locally
     try:
         import sphinx_rtd_theme

-        html_theme = 'sphinx_rtd_theme'
-        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), '.']
+
+        html_theme = "sphinx_rtd_theme"
+        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]

     except:
     except:

-        html_theme = 'default'
-        html_theme_path = ['.']
+        html_theme = "default"
+        html_theme_path = ["."]

 else:
 else:

-    html_theme_path = ['.']
+    html_theme_path = ["."]

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

 
 # Output file base name for HTML help builder.
 
 # Output file base name for HTML help builder.

-htmlhelp_basename = 'AdafruitBlinkaLibrarydoc'
+htmlhelp_basename = "AdafruitBlinkaLibrarydoc"

 
 # -- Options for LaTeX output ---------------------------------------------
 
 latex_elements = {
 
 # -- 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',
+    # 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 = [
 }
 
 # 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, 'AdafruitBlinkaLibrary.tex', u'AdafruitBlinka Library Documentation',
-     author, 'manual'),
+    (
+        master_doc,
+        "AdafruitBlinkaLibrary.tex",
+        "AdafruitBlinka Library Documentation",
+        author,
+        "manual",
+    ),

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


@@ -135,8 +152,13 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [

-    (master_doc, 'AdafruitBlinkalibrary', u'Adafruit Blinka Library Documentation',
-     [author], 1)
+    (
+        master_doc,
+        "AdafruitBlinkalibrary",
+        "Adafruit Blinka Library Documentation",
+        [author],
+        1,
+    )

 ]
 
 # -- Options for Texinfo output -------------------------------------------
 ]
 
 # -- Options for Texinfo output -------------------------------------------


@@ -145,7 +167,13 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [

-    (master_doc, 'AdafruitBlinkaLibrary', u'Adafruit Blinka Library Documentation',
-     author, 'AdafruitBlinkaLibrary', 'One line description of project.',
-     'Miscellaneous'),
+    (
+        master_doc,
+        "AdafruitBlinkaLibrary",
+        "Adafruit Blinka Library Documentation",
+        author,
+        "AdafruitBlinkaLibrary",
+        "One line description of project.",
+        "Miscellaneous",
+    ),

 ]
 ]