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: declare board compatibility through a YAML file #160

Merged
merged 2 commits into from
Jan 12, 2022

Conversation

umarcor
Copy link
Contributor

@umarcor umarcor commented Jan 12, 2022

Instead of manually writing the board compatibility table in the docs, this PR uses a YAML file and a Python script:

  • Boards are declared in the YAML file, which provides a machine-readable solution for consumers of this repo to query the data.
  • The Python script reads the YAML file and generates a restructuredtext table through tabulate.

No content is changed, so the documentation looks exactly the same. This is an internal enhancement related to #105.

@umarcor umarcor force-pushed the doc-yaml branch 2 times, most recently from 57e9860 to 4be407a Compare January 12, 2022 02:35
@trabucayre trabucayre merged commit 8f4dd88 into trabucayre:master Jan 12, 2022
@trabucayre
Copy link
Owner

Awesome!
Thanks for this update!
Applied!

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.

None yet

2 participants