diff --git a/README.md b/README.md index a9dc316a..5dcfe017 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,5 @@ [![PyPI](https://img.shields.io/pypi/dm/cocotb-bus.svg?label=PyPI%20downloads)](https://pypi.org/project/cocotb-bus/) -The new home of the [cocotb](https://github.com/cocotb) project's pre-packaged testbenching tools and reusable bus interfaces. +**cocotb-bus** contains pre-packaged testbenching tools and +reusable bus interfaces for [cocotb](https://cocotb.org). diff --git a/docs/source/index.rst b/docs/source/index.rst index 91af565e..323c1516 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,6 +1,6 @@ -###################################### +************************************** Welcome to cocotb-bus's documentation! -###################################### +************************************** .. This documentation tries to follow https://www.divio.com/blog/documentation/ (Daniele Procida) @@ -11,9 +11,8 @@ Welcome to cocotb-bus's documentation! See also https://github.com/cocotb/cocotb/wiki/Howto:-Writing-Documentation -******************* What is cocotb-bus? -******************* +=================== **cocotb-bus** consists of pre-packaged testbenching tools and reusable bus interfaces for https://cocotb.org. @@ -24,6 +23,14 @@ A bit more detailed, cocotb-bus is: * An implementation of a scoreboard class for cocotb. * Sample implementation of protocol bus drivers using these classes. +Dependencies +------------ + +In addition to what cocotb itself requires, +cocotb-bus has a dependency on ``scapy`` (https://scapy.readthedocs.io/) +for its :func:`scapy.utils.hexdump` and :func:`scapy.utils.hexdiff` functions +used in the :mod:`.scoreboard`. + .. toctree:: :maxdepth: 1 diff --git a/docs/source/newsfragments/68.change.rst b/docs/source/newsfragments/68.change.rst new file mode 100644 index 00000000..ae2f2e1e --- /dev/null +++ b/docs/source/newsfragments/68.change.rst @@ -0,0 +1 @@ +cocotb-bus now depends on ``scapy`` (https://scapy.readthedocs.io/) for its :func:`scapy.utils.hexdump` and :func:`scapy.utils.hexdiff` functions used in the :mod:`.scoreboard`. diff --git a/docs/source/newsfragments/README.rst b/docs/source/newsfragments/README.rst new file mode 100644 index 00000000..24de8c67 --- /dev/null +++ b/docs/source/newsfragments/README.rst @@ -0,0 +1,56 @@ +:orphan: + +********************* +Writing Release Notes +********************* + +We are using `towncrier `_ to handle +our release notes, and this directory contains the input for it - +"news fragments" which are short files that contain a small +**ReST**-formatted text that will be added to the next version's +Release Notes page. + +Each file should be named like ``..rst``, +where ```` is an issue or a pull request number - +whatever is most useful to link to, +and ```` is one of: + +* ``feature``: New user-facing feature. +* ``bugfix``: A bug fix. +* ``doc``: Documentation improvement. +* ``removal``: Deprecation or removal of public API or behavior. +* ``change``: A change in public API or behavior. + +In that file, make sure to use full sentences with correct case and punctuation, +and do not use a bullet point at the beginning of the file. +Each fragment file should be a single piece of news on a single line; +multi-line files will not render correctly. +In cases where there is more than one piece of news for a pull request, +split the news into 2 fragments (see below for details on how to do that). +Use Sphinx references (see https://sphinx-tutorial.readthedocs.io/cheatsheet/) +if you refer to added classes, methods etc. + +Additional newsfragments of the same ```` for a single ```` are +supported, using the name format ``..<#>.rst``. + +Example: + +* ``.bugfix.rst`` +* ``.bugfix.1.rst`` + +An example file could consist of the content between the marks: + +--8<--8<--8<--8<--8<--8<--8<--8<--8<--8<--8<--8<--8<--8<--8<--8<--8<--8<--8<--8< +Summary of a new feature. + +This is a second paragraph. +-->8-->8-->8-->8-->8-->8-->8-->8-->8-->8-->8-->8-->8-->8-->8-->8-->8-->8-->8-->8 + +Note that the last paragraph should be a normal sentence and not e.g. code, +because the issue number is appended there. + +Towncrier automatically assembles a list of unreleased changes when building Sphinx, +meaning your notes will be visible in the documentation immediately after merging. +When performing a release, ``towncrier`` should be run independently +(in cocotb-bus's root directory), +which will delete all the merged newsfragments, and create new commits. diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst new file mode 100644 index 00000000..2baa312d --- /dev/null +++ b/docs/source/release_notes.rst @@ -0,0 +1,12 @@ +************* +Release Notes +************* + +.. spelling:word-list:: + dev + +All releases are available from the `GitHub Releases Page `_. + +.. include:: master-notes.rst + +.. towncrier release notes start