Catherine
324c37f9fa
docs/stdlib/io: document I/O buffer library.
2024-05-21 15:58:59 +00:00
Catherine
cd679dd9b3
docs: exempt https://amaranth-lang.org/schema/ (exact) from linkcheck.
2024-05-11 08:55:53 +00:00
Jean-François Nguyen
496432edaa
Implement RFC 30: Component metadata.
...
Co-authored-by: Catherine <whitequark@whitequark.org>
2024-05-10 13:17:24 +00:00
Catherine
1a962cc405
docs: remove all generated WaveDrom diagrams.
2024-04-10 01:30:10 +00:00
Catherine
6fb5f3f120
docs/memory: use wavedrom directive for diagrams.
2024-04-07 08:03:44 +00:00
Catherine
e3c9296813
docs: introduce custom "Members" section, for lib.wiring signatures.
2024-03-22 23:05:42 +00:00
Catherine
52842ee524
docs: fix link rot.
2024-02-15 19:58:19 +00:00
Catherine
b9c9948038
docs: use :py: role for inline Python code, not :pc:.
...
I originally picked :pc: as it is short for "python code", but it is
obscure and :py: is not taken, so a much more obvious role can be used
instead. Also, we all typo :pc: as :py: all the time anyway.
2024-02-13 10:38:36 +00:00
Catherine
6211eca4ac
docs: update cover, title, and copyright.
2024-01-17 18:29:16 +00:00
Catherine
8ac22bc114
docs: add logo.
2024-01-04 16:47:32 +00:00
Catherine
e356ee2cac
docs: strip .editable suffix from version.
...
This shows up in CI builds as well, since those use `pip install -e`.
2024-01-04 16:47:32 +00:00
Catherine
a2aa07cbc7
lib.wiring: document amaranth-lang/rfcs#2 . WIP
...
Co-authored-by: Charlotte <charlotte@hrzn.ee>
2023-12-11 22:57:30 +00:00
Catherine
57612f1dce
lib.enum: add Enum wrappers that allow specifying shape.
...
See #756 and amaranth-lang/rfcs#3 .
2023-02-28 13:00:41 +00:00
Catherine
e2f0519774
docs: upgrade Sphinx.
2023-02-17 09:59:19 +00:00
Catherine
18837b9029
docs: cover amaranth.lib.cdc.
2021-12-13 06:23:12 +00:00
Catherine
3a8cd63b23
docs: cover amaranth.lib.coding.
2021-12-13 05:48:31 +00:00
whitequark
0fb2b4cd39
docs: fix download link in start.rst.
...
Fixes #647 .
2021-12-11 06:32:32 +00:00
whitequark
909a3b8be7
Rename nMigen to Amaranth HDL.
2021-12-10 10:34:13 +00:00
whitequark
1fbd7f1d08
docs: use sphinxcontrib-platformpicker.
...
Fixes #416 .
2020-07-05 23:39:47 +00:00
whitequark
6c0530cf4e
docs: clarify naming.
2020-07-01 08:53:52 +00:00
whitequark
76c7e70582
docs: add a crude approximation of intersphinx toctrees.
...
This is a pretty awful hack. We could do this properly after one of
the following issues is fixed:
* sphinx-doc/sphinx#701
* sphinx-doc/sphinx#1836
2020-07-01 08:03:57 +00:00
whitequark
c20266164d
docs: rewrite install instructions to be easier to understand.
2020-07-01 03:32:17 +00:00
whitequark
399b8f9863
Add (heavily work in progress) documentation.
...
To render correctly, the docs require:
* pygments/pygments#1441
2020-06-30 22:21:16 +00:00
