Conversation
- switch to sphinx_book_theme, add SiLab logo - merge introduction into overview landing page - add BDAQ53 hardware section with board photo - fix broken blockdiag (was deprecated), replace with graphviz - fix firmware module include paths - update links to cocotb and in-repo files - update README with current example projects - add .readthedocs.yaml for RTD builds (will fail without)
- fix author field and add SiLab link to footer - remove dark mode toggle, force light mode - replace dead Redmine and Avnet links with notes - document YAML config and available module types under each layer section - add autodoc for Hardware Layer and Register Layer base classes - fix WaveDrom timing diagrams (https, broken JS loader) - clean up firmware page intro and bus section - update README to match overview page - capitalize module titles, fix typos across module READMEs - remove link underlines
Member
Author
|
Here's a before: And after for the documentation formatting: |
cbespin
requested changes
Mar 26, 2026
Contributor
cbespin
left a comment
cbespin
left a comment
There was a problem hiding this comment.
Very nice work, thank you! The comments include a mix of compliments, questions regarding English language and requests for changes. Obviously, not all are super relevant
.readthedocs.yaml
Outdated
| version: 2 | ||
|
|
||
| build: | ||
| os: ubuntu-22.04 |
Contributor
There was a problem hiding this comment.
We should go at least to ubuntu-24.04 or just ubuntu-latest. Only a matter of time until 22.04 is deprecated in runners; after all, the release was four years ago.
- Make units (mA, -bit, mV, etc) with consistent spaces) - Update diagram for firmware, to make it pretty - Build docs with Ubuntu latest - Make it clear that lab devices are support, and use serial links - Yeah, we don't irradiate BDAQ53 lol, my B
cbespin
requested changes
Mar 26, 2026
docs/index.rst
Outdated
| ############ | ||
|
|
||
| Basil is a modular data acquisition (DAQ) framework developed by `SiLab <https://silab-bonn.github.io/>`_ for the characterization of `monolithic <https://en.wikipedia.org/wiki/Monolithic_active_pixel_sensor>`_ and `hybrid <https://en.wikipedia.org/wiki/Hybrid_pixel_detector>`_ pixel detectors. It comprises a library of HDL modules (written in Verilog) for custom FPGA readout boards, paired with a collection of Python code that control the hardware over TCP/IP from a host PC. | ||
| Basil is a modular data acquisition (DAQ) framework developed by `SiLab <https://silab-bonn.github.io/>`_ for the characterization of `monolithic <https://en.wikipedia.org/wiki/Monolithic_active_pixel_sensor>`_ and `hybrid <https://en.wikipedia.org/wiki/Hybrid_pixel_detector>`_ pixel detectors. It comprises a library of HDL modules (written in Verilog) for custom FPGA readout boards, paired with a collection of Python code that control the hardware over USB, Ethernet, or serial interfaces from a host PC. Basil also includes Python drivers for common lab instruments such as X-ray tubs, chillers, power supplies, oscilloscopes, and other lab equipment. |
Contributor
There was a problem hiding this comment.
X-ray tubs -> X-ray tubes (and maybe revert the list, as power supplies, oscilloscopes, ... are the main interest)
Contributor
|
Thanks for the great effort. One very last thing, and then we can merge 🎉 |
Member
Author
|
Great, thanks for reading over the changes. Added your remaining feedback, so we should be good to go. |
cbespin
approved these changes
Mar 26, 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.
Hey, opening a pull request to get the docs building. Will stop by to discuss whether this is the right manner in which to do so.