mirror of
https://github.com/osiweb/unified_retro_keyboard.git
synced 2024-11-29 05:49:22 +00:00
21a30d2ca0
- Add a documentation directory to start documenting the firmware in sphinx. c - Fix cmake scripts to generate files needed to make hex files available for download - expand build script to automate the cmake file generation and builds for each architecture, install the python virtual environment needed for sphinx, and and to populate the sphinx source tree with links to built hex files.
64 lines
2.3 KiB
Python
64 lines
2.3 KiB
Python
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# 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
|
|
import re
|
|
import toml
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "ASDF - Unified Retro Keyboard Firmware"
|
|
copyright = "2022 Osiweb.org"
|
|
author = "David F"
|
|
|
|
# -- 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.napoleon",
|
|
"sphinx.ext.autodoc", # Core library for html generation from docstrings
|
|
"sphinx_autodoc_typehints",
|
|
"sphinx.ext.viewcode",
|
|
"sphinx.ext.autosectionlabel",
|
|
"sphinx.ext.autosummary", # Create neat summary tables
|
|
]
|
|
autosummary_generate = True # Turn on sphinx.ext.autosummary
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ["_templates"]
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = []
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
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"
|
|
] # Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# For the full list of built-in configuration values, see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|