|
|
- # -*- coding: utf-8 -*-
-
- import os
- import sys
-
- sys.path.insert(0, os.path.abspath(".."))
-
- # -- 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 = [
- "sphinx.ext.autodoc",
- "sphinx.ext.intersphinx",
- "sphinx.ext.napoleon",
- "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.
- autodoc_mock_imports = ["machine"]
-
- intersphinx_mapping = {
- "python": ("https://docs.python.org/3.6", None),
- "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None),
- }
-
- # Add any paths that contain templates here, relative to this directory.
- templates_path = ["_templates"]
-
- source_suffix = ".rst"
-
- # The master toctree document.
- master_doc = "index"
-
- # General information about the project.
- project = "Adafruit PlatformDetect Library"
- copyright = "2017 Adafruit Industries"
- author = "Brennen Bearnes"
-
- # 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 = "1.0.0"
- # The full version, including alpha/beta/rc tags.
- 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.
- 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
- 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.
- #
- 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.
- pygments_style = "sphinx"
-
- # If true, `todo` and `todoList` produce output, else they produce nothing.
- todo_include_todos = False
-
- # If this is True, todo emits a warning for each TODO entries. The default is False.
- todo_emit_warnings = True
-
- napoleon_numpy_docstring = False
-
- # -- Options for HTML output ----------------------------------------------
-
- # 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"
-
- 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 = ["."]
-
- # 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 = "AdafruitPlatformDetectLibrarydoc"
-
- # -- 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 = [
- (
- master_doc,
- "AdafruitPlatformDetectLibrary.tex",
- "AdafruitPlatformDetect Library Documentation",
- author,
- "manual",
- ),
- ]
-
- # -- 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,
- "AdafruitPlatformDetectlibrary",
- "Adafruit PlatformDetect Library Documentation",
- [author],
- 1,
- )
- ]
-
- # -- 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,
- "AdafruitPlatformDetectLibrary",
- "Adafruit PlatformDetect Library Documentation",
- author,
- "AdafruitPlatformDetectLibrary",
- "One line description of project.",
- "Miscellaneous",
- ),
- ]
|