doc: add field 'Constraints' to 'boards.yml' #161
Merged
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.
This is a follow-up of #160, related to #105.
An optional field,
Constraints
, is added to each item inboards.yml
.Constraints
can contain an string or a list of strings, matching the boad identifiers used in hdl/constraints.At the same time, an intersphinx mapping to hdl/constraints was added to the documentation configuration. When building the documentation, a new column is added to the boards compatibility table, which contains cross-references to hdl.github.io/constraints/Data/Boards. See umarcor.github.io/openFPGALoader/compatibility/board.
@trabucayre, as discussed in #105 (comment), the purpose is each repo to keep their own data/details. These "keywords" allow cross-referencing through interpshinx, as shown in this PR. Furthermore, after this PR is merged, we can use the
boards.yml
andboards.py
files from this repo to enhance the documentation of hdl/constraints.We can later improve this iteratively: