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

litex_sata_demo/readme: support using lists, tables or roles #365

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

umarcor
Copy link
Contributor

@umarcor umarcor commented Sep 29, 2022

It seems that fill_context from collect_readmes does process the README.rst files in order to generate "contexts" which are then consumed by jinja. Apparently, collect_readmes cannot handle lists, tables or roles.
None of the other example readmes use lists or tables. That's probably why we had not found this problem before.

However, I am unsure about modifying/enhancing collect_readmes being the way to go. Can anyone tell why are we using jinja? If we are executing custom code in the conf.py, we could just copy the readmes to docs/xc7 and docs/eos-s3. Moreover, we could (should) maintain the readmes in the docs subir, not spread along the repo.

@mithro @kgugala @tmichalak wdyt?

@umarcor umarcor force-pushed the umarcor/docs/litex-sata branch 3 times, most recently from 63646c6 to 4b8aa2a Compare December 16, 2022 10:20
@umarcor umarcor changed the title litex_sata_demo/readme: use a list instead of a table litex_sata_demo/readme: support using lists, tables or roles Dec 16, 2022
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
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.

1 participant