7870eb344b
This commit includes additional non-documentation changes, related to issues found while documenting it: - `Simulator.run_until()` no longer accepts a `run_passive=` argument. Passive no longer exist and in any case defaulting to `False` does not make a lot of sense from an API perspective. - `add_clock()`'s `phase=` argument, when specified, no longer has `period/2` added to it. This wasn't the documented behavior in first place and it makes no sense to do that. - `add_clock()` raises a `NameError` if a clock domain does not exist, instead of `ValueError`. - `add_clock()` raises a `DriverConflict` if a clock domain is already being driven by a clock, instead of `ValueError`. - GTKWave is no longer a part of the installation instructions, and both Surfer and GTKWave are recommended (in this order).
85 lines
2.2 KiB
Python
85 lines
2.2 KiB
Python
import os, sys
|
|
sys.path.insert(0, os.path.abspath("."))
|
|
|
|
import time
|
|
from importlib.metadata import version as package_version
|
|
|
|
|
|
project = "Amaranth language & toolchain"
|
|
version = package_version('amaranth').replace(".editable", "")
|
|
release = version.split("+")[0]
|
|
copyright = time.strftime("2020—%Y, Amaranth project contributors")
|
|
|
|
extensions = [
|
|
"sphinx.ext.intersphinx",
|
|
"sphinx.ext.doctest",
|
|
"sphinx.ext.todo",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx_rtd_theme",
|
|
"sphinxcontrib.platformpicker",
|
|
"sphinxcontrib.yowasp_wavedrom",
|
|
]
|
|
|
|
with open(".gitignore") as f:
|
|
exclude_patterns = [line.strip() for line in f.readlines()]
|
|
|
|
root_doc = "cover"
|
|
|
|
intersphinx_mapping = {
|
|
"python": ("https://docs.python.org/3", None),
|
|
}
|
|
|
|
todo_include_todos = True
|
|
|
|
autodoc_member_order = "bysource"
|
|
autodoc_default_options = {
|
|
"members": True
|
|
}
|
|
autodoc_preserve_defaults = True
|
|
autodoc_inherit_docstrings = False
|
|
|
|
# Amaranth mostly does not include typehints, and showing them in some places but not others is
|
|
# worse than not showing them at all.
|
|
autodoc_typehints = "none"
|
|
|
|
napoleon_google_docstring = False
|
|
napoleon_numpy_docstring = True
|
|
napoleon_use_ivar = True
|
|
napoleon_include_init_with_doc = True
|
|
napoleon_include_special_with_doc = True
|
|
napoleon_custom_sections = [
|
|
("Attributes", "params_style"), # by default displays as "Variables", which is confusing
|
|
("Members", "params_style"), # `lib.wiring` signature members
|
|
"Platform overrides"
|
|
]
|
|
|
|
html_theme = "sphinx_rtd_theme"
|
|
html_static_path = ["_static"]
|
|
html_css_files = ["custom.css"]
|
|
html_logo = "_static/logo.png"
|
|
|
|
rst_prolog = """
|
|
.. role:: py(code)
|
|
:language: python
|
|
"""
|
|
|
|
linkcheck_ignore = [
|
|
r"^http://127\.0\.0\.1:8000$",
|
|
# Picked up automatically by ReST and doesn't have an index.
|
|
r"^https://amaranth-lang\.org/schema/$",
|
|
]
|
|
|
|
linkcheck_anchors_ignore_for_url = [
|
|
r"^https://matrix\.to/",
|
|
r"^https://web\.libera\.chat/",
|
|
# React page with README content included as a JSON payload.
|
|
r"^https://github\.com/[^/]+/[^/]+/$",
|
|
]
|
|
|
|
|
|
# Silence the warnings globally; otherwise they may fire on object destruction and crash completely
|
|
# unrelated tests.
|
|
import amaranth._unused
|
|
amaranth._unused.MustUse._MustUse__silence = True
|