Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add field 'Constraints' to 'boards.yml' #161

Merged
merged 2 commits into from
Jan 13, 2022

Conversation

umarcor
Copy link
Contributor

@umarcor umarcor commented Jan 12, 2022

This is a follow-up of #160, related to #105.

An optional field, Constraints, is added to each item in boards.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 and boards.py files from this repo to enhance the documentation of hdl/constraints.

We can later improve this iteratively:

  • Add misssing boards to hdl/constraints.
  • Evaluate adding fields to the YAML here or there, and/or moving fields from one to the other.
  • Update the layout in the site here, in order to show a section per board, instead of or apart from the table.
  • etc.

@umarcor umarcor changed the title doc: add field 'Constraints' to 'boards.yaml' doc: add field 'Constraints' to 'boards.yml' Jan 12, 2022
@trabucayre trabucayre merged commit 54a5558 into trabucayre:master Jan 13, 2022
@trabucayre
Copy link
Owner

Really useful informations/field!
I have to see how to limit columns size to avoid a big horizontal scroll.
Thanks!
Applied

@umarcor umarcor deleted the doc-constraints branch January 13, 2022 12:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants