Docs: Use rstflattable for tables
Nobody has claimed this yet.
- Dominant language
- SystemVerilog
- Stars
- 2.1k
- Forks
- 810
- Avg merge
- 5d 23h
- Merged PRs (30d)
- 9
Description
Tables in reStructuredText can be quite annoying to produce; a very comfortable solution is a Sphinx plugin, that converts lists to tables.
Example of it being used: https://github.com/opensocdebug/osd-doc/blob/master/src/02_spec/03_dataformats.rst#L47
Extension: https://github.com/opensocdebug/osd-doc/blob/master/sphinx/rstFlatTable.py
Config: https://github.com/opensocdebug/osd-doc/blob/master/src/conf.py#L33
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the referenced rstFlatTable.py extension and the src/conf.py configuration, using the linked dataformats.rst example as a model. Identify the Ibex documentation tables to convert, build the docs, and confirm the resulting reStructuredText tables render correctly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100