litex_sata_demo/readme: support using lists, tables or roles #365
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.
conf.py
modulecollect_readmes
is imported and used: https://github.com/chipsalliance/f4pga-examples/blob/main/docs/conf.py#L86-L98. That's a local Python module: https://github.com/chipsalliance/f4pga-examples/blob/main/docs/collect_readmes.py.It seems that
fill_context
fromcollect_readmes
does process theREADME.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 theconf.py
, we could just copy the readmes todocs/xc7
anddocs/eos-s3
. Moreover, we could (should) maintain the readmes in the docs subir, not spread along the repo.@mithro @kgugala @tmichalak wdyt?