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.

Sign up for GitHub

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

Jump to bottom

docs/building-examples: add linux_litex_demo and litex_sata_demo #363

Merged
merged 2 commits into from
Dec 16, 2022
Merged

docs/building-examples: add linux_litex_demo and litex_sata_demo #363

merged 2 commits into from
Dec 16, 2022

Conversation

umarcor
Copy link
Contributor

@umarcor umarcor commented Sep 10, 2022 •
edited
Loading

Close #362.

@umarcor umarcor force-pushed the umarcor/docs/litex branch 3 times, most recently from e626c29 to e6d697e Compare September 10, 2022 01:05
@umarcor umarcor added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 10, 2022
@umarcor umarcor mentioned this pull request Sep 29, 2022
Draft
@mithro mithro marked this pull request as ready for review December 15, 2022 15:37
@mithro
Copy link
Contributor

mithro commented Dec 15, 2022

@kgugala - This looks good to me?

@mithro mithro requested a review from kgugala December 15, 2022 15:38
@umarcor umarcor marked this pull request as draft December 15, 2022 16:08
@umarcor
Copy link
Contributor Author

umarcor commented Dec 15, 2022

@mithro, this is not exactly ready for review. See https://f4pga-examples--363.org.readthedocs.build/en/363/xc7/litex_sata_demo.html.
There is some problem when processing https://github.com/chipsalliance/f4pga-examples/blob/main/xc7/litex_sata_demo/README.rst through the jinja template.

So, we can merge it as-is, assuming that broken visualisation. Or we can keep this on hold until #365 is solved.

@umarcor
docs/building-examples: add linux_litex_demo and litex_sata_demo
7d011bc 
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
@umarcor
litex_sata_demo/readme: avoid tables, lists or roles until the jinja …
c321cd9 
…template is fixed

Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
@umarcor
Copy link
Contributor Author

umarcor commented Dec 16, 2022

I updated this PR to avoid the usage of tables, lists or roles in the README of the examples, due to the jinja template being broken if those features are used.
Hence, this PR is good to merge. We can deal with the jinja issues in #365.

@umarcor umarcor marked this pull request as ready for review December 16, 2022 10:43
tmichalak
tmichalak approved these changes Dec 16, 2022
View reviewed changes
Copy link
Collaborator

@tmichalak tmichalak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tmichalak tmichalak merged commit 8a62c19 into chipsalliance:main Dec 16, 2022
@umarcor umarcor deleted the umarcor/docs/litex branch December 16, 2022 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tmichalak tmichalak tmichalak approved these changes

@kgugala kgugala Awaiting requested review from kgugala

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

What happened to the LiteX Linux and LiteX SATA demos?
3 participants
@umarcor @mithro @tmichalak