Include missing firmware READMEs#273
Merged
Merged
Conversation
rpartzsch
requested changes
May 28, 2026
rpartzsch
left a comment
rpartzsch
left a comment
Contributor
There was a problem hiding this comment.
Nice, I think the bram_fifo is still missing. But this should be all of them.
Member
Author
|
Ah okay, so I think this needs to be cleared up: The BRAM docs currently look like the below snippet, but that's mixing up the BRAM and SRAM fifos, right? .. !BRAM_FIFO!
.. include:: ../basil/firmware/modules/bram_fifo/README.rst
**Driver:**
.. automodule:: basil.HL.sram_fifo
.. autoclass:: sram_fifo
:members: |
Member
Author
|
I think I've cleaned this up now, and added missing doc strings for the drivers of the |
Contributor
|
You are right. Looks good to me. |
rpartzsch
approved these changes
May 28, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #267
Adding the missing firmware README files in docs/modules.rst and renames the mixed-case Readme.rst filenames to README.rst.