ci(docs): render manufacturer-specific docs #531
Draft
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.
Description
This generates the rustdoc docs for the manufacturer-specific crates (MSCs) that were extracted as part of #392.
The doc page of the
riot_rs::arch
module provides the user with a "manual redirect" to the items relevant for the target MCU, provided by the MSCs.The current state of the generated docs can be seen on my fork: https://romemories.github.io/RIOT-rs/dev/docs/api/riot_rs/arch/index.html
Limitations
The documentation of the MSCs are currently rendered for one MCU only (and that MCU is not currently mentioned in the docs). This is a significant limitation, but it's unclear how solve that in the general case (e.g.,
riot-rs-stm32
may end supporting 1400 different MCUs).E.g., the nRF5340 also supports 250 kHz as an I2C frequency, but this does not currently appear in the docs because they are currently rendered for the nrf52840 only.
Issues/PRs references
This is the continuation of #392.
Open Questions
Frequency
types) but others are completely internal. We should agree on how we go about hiding those.Change checklist