2023-08-16 12:57:14 +00:00
|
|
|
# Configuration file for the Sphinx documentation builder.
|
|
|
|
|
#
|
|
|
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
|
|
|
|
|
|
project = 'HDL, Analog Devices'
|
|
|
|
|
copyright = '2023, Analog Devices Inc'
|
|
|
|
|
author = 'Analog Devices Inc'
|
|
|
|
|
release = 'v0.1'
|
|
|
|
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
|
|
|
|
|
|
import os, sys
|
|
|
|
|
|
|
|
|
|
sys.path.append(os.path.abspath("./extensions"))
|
|
|
|
|
|
|
|
|
|
extensions = [
|
|
|
|
|
"sphinx.ext.todo",
|
|
|
|
|
"sphinx.ext.viewcode",
|
|
|
|
|
"sphinxcontrib.wavedrom",
|
|
|
|
|
"adi_links",
|
|
|
|
|
"adi_hdl_parser"
|
|
|
|
|
]
|
|
|
|
|
|
|
|
|
|
templates_path = ['sources/template']
|
|
|
|
|
|
|
|
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
|
|
|
|
|
|
# -- Custom extensions configuration -------------------------------------------
|
|
|
|
|
|
2023-08-18 20:29:31 +00:00
|
|
|
hide_collapsible_content = True
|
docs: links, drop part, fixups, codeowners
Drop part role, use generic adi instead for root adi domain links.
For future reference, the snipped used was:
find ./docs/projects -type f -exec sed -i 's/:part:/:adi:/g' {} \;
Drop Containerfile.
Add option to validate links status (e.g. 200, 404), intended mostly for CI
use to check if a page has disappeared from the internet.
Validate links uses coroutines to launch multiple tasks concurrently,
but do it in bundles to avoid being rate limited.
Fixup regmap styling.
Add imoldovan, jmarques, spop, lbarbosa as docs codeowners.
Remove branch field for links to the hdl repo.
Change git role to display full path.
Fixup ZedBoard link label, remove IP List, add SYSID_ROM dokuwiki link
in ad716_sdz project.
Signed-off-by: Jorge Marques <jorge.marques@analog.com>
2023-11-13 15:42:46 +00:00
|
|
|
validate_links = False
|
2023-08-07 19:31:41 +00:00
|
|
|
|
2023-08-16 12:57:14 +00:00
|
|
|
# -- todo configuration -------------------------------------------------------
|
|
|
|
|
|
|
|
|
|
todo_include_todos = True
|
|
|
|
|
todo_emit_warnings = True
|
|
|
|
|
|
|
|
|
|
# -- Options for HTML output --------------------------------------------------
|
|
|
|
|
|
|
|
|
|
html_theme = 'furo'
|
|
|
|
|
html_static_path = ['sources']
|
|
|
|
|
source_suffix = '.rst'
|
|
|
|
|
html_css_files = ["custom.css"]
|
|
|
|
|
html_favicon = "sources/icon.svg"
|
