Skip to content

Commit

Permalink
Write testing docs. Tentatively all docs except docstrings finished.
Browse files Browse the repository at this point in the history
  • Loading branch information
cr1901 committed Dec 9, 2024
1 parent 805b5cc commit c93a3f9
Show file tree
Hide file tree
Showing 9 changed files with 541 additions and 252 deletions.
5 changes: 4 additions & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
try:
sent_ver = Version(importlib.metadata.version("sentinel"))
am_ver = Version(importlib.metadata.version("amaranth"))
# riscof_ver = Version(importlib.metadata.version("riscof"))
except importlib.metadata.PackageNotFoundError as e:
msg = "run \"pdm install --dev -G dev -G doc\" before building docs"
raise RuntimeError(msg) from e
Expand Down Expand Up @@ -66,7 +67,9 @@
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

intersphinx_mapping = {'python': ('https://docs.python.org/3', None),
'amaranth': (f'https://amaranth-lang.org/docs/amaranth/{am_ver}/', None)} # noqa: E501
'amaranth': (f'https://amaranth-lang.org/docs/amaranth/{am_ver}/', None), # noqa: E501
# 'riscof': (f'https://riscof.readthedocs.io/en/{riscof_ver}/', None)} # noqa: E501
'riscof': ('https://riscof.readthedocs.io/en/stable/', None)} # noqa: E501
autodoc_default_options = {"members": True,
"undoc-members": True}
todo_include_todos = True
Expand Down
3 changes: 2 additions & 1 deletion doc/development/internals.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,8 @@ Sentinel physically implements the following CSRs:
* There is no machine timer (a 64-bit counter is a bit too much to
ask for right now :(...).
* `mip`
* Only the `MEIP` bit is implemented. The RISC-V Privileged Spec says:
* Only the `MEIP` bit is implemented. The `MSIP` and `MTIP` bits always read
as zero. The RISC-V Privileged Spec says:

> `MEIP` is read-only in `mip`, and is set and cleared by a
> platform-specific interrupt controller.
Expand Down
Loading

0 comments on commit c93a3f9

Please sign in to comment.