docs: cover amaranth.lib.cdc.

This commit is contained in:
Catherine 2021-12-13 06:23:12 +00:00
parent 3a8cd63b23
commit 18837b9029
4 changed files with 39 additions and 24 deletions

View file

@ -30,6 +30,7 @@ todo_include_todos = True
napoleon_google_docstring = False
napoleon_numpy_docstring = True
napoleon_use_ivar = True
napoleon_custom_sections = ["Platform overrides"]
html_theme = "sphinx_rtd_theme"
html_static_path = ["_static"]

View file

@ -9,3 +9,4 @@ Standard library
:maxdepth: 2
stdlib/coding
stdlib/cdc

13
docs/stdlib/cdc.rst Normal file
View file

@ -0,0 +1,13 @@
Clock domain crossing
#####################
.. py:module:: amaranth.lib.cdc
The ``amaranth.lib.cdc`` package provides modules for transferring data between clock domains.
.. autoclass:: FFSynchronizer()
.. autoclass:: AsyncFFSynchronizer()
.. autoclass:: ResetSynchronizer()
.. autoclass:: PulseSynchronizer()