Merge pull request #977 from FoamyGuy/lgpio_req_<py313

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

diff --git a/docs/conf.py b/docs/conf.py
index 8f25b4c42f10fc433ad16ceb4c2b78c23f49e44b..35c7aeafbcbf5a0e28f84e04c26525f755d904c4 100755 (executable)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,5 +1,9 @@
 # -*- coding: utf-8 -*-
 
+# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
+#
+# SPDX-License-Identifier: MIT
+
 import os
 import sys
 
@@ -19,10 +23,17 @@ extensions = [
 # 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", "RPi", "RPi.GPIO", "hid", "sysv_ipc"]
+autodoc_mock_imports = [
+    "machine",
+    "Adafruit_GPIO",
+    "RPi",
+    "RPi.GPIO",
+    "hid",
+    "sysv_ipc",
+]
 
 intersphinx_mapping = {
-    "python": ("https://docs.python.org/3.4", None),
+    "python": ("https://docs.python.org/3.7", None),
     "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
 }
 
@@ -53,7 +64,7 @@ release = "1.0.0"
 #
 # 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.
@@ -86,25 +97,21 @@ todo_emit_warnings = 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
-
-        html_theme = "sphinx_rtd_theme"
-        html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."]
-    except:
-        html_theme = "default"
-        html_theme_path = ["."]
-else:
-    html_theme_path = ["."]
+html_theme = "sphinx_rtd_theme"
 
 # 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"]
 
+# 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.
+#
+html_favicon = "_static/favicon.ico"
+
 # Output file base name for HTML help builder.
-htmlhelp_basename = "AdafruitBlinkaLibrarydoc"
+htmlhelp_basename = "Adafruit_blinkaDisplayioLibrarydoc"
 
 # -- Options for LaTeX output ---------------------------------------------