Skip to content

Conversation

ericfont
Copy link

The formatting of the inline status table in overview.rst was problematic, because the newlines in each table would produce spaces when rendered in GitHub or Sphinx docs and because the Spinx formatting in https://prjicestorm.readthedocs.io/en/latest/overview.html would undesirably replace any "--" with "–". I'm instead putting the whole file in a separate .csv and linking to it, which renders nicely in github and can be edited in spreadsheet editors or as raw text. (I don't actually know what .csv files look like in Sphinx, though)

@ericfont ericfont force-pushed the format-table-csv branch 2 times, most recently from 65fedc9 to 1bbd535 Compare February 24, 2025 22:48
@ericfont
Copy link
Author

Did some force pushes, but I got the inline table working inside Sphinx by including the .csv, and I also figured out how to avoid "--" becoming a single long dash by disabling the Sphinx option "smartquotes" in conf.py, so now the table renders inline like:

image

Meanwhile when viewed on github the table isn't inline, but clicking on the link in github will render it nicely like:

image

@mmicko
Copy link
Member

mmicko commented Feb 25, 2025

Thanks @ericfont it looks fine when generated as HTML. If you wish to setup that locally there are instructions in https://github.com/YosysHQ/icestorm/blob/master/docs/README.md just do make html after that and it will appear in build/html

Not sure if CSV to download is needed for this page have to think. Also would like to check other tables to see if there are any worth converting the same way, rest I can fix by hand.

@ericfont
Copy link
Author

ericfont commented Feb 25, 2025

The (https://github.com/YosysHQ/icestorm/blob/master/docs/source/ultraplus.rst#spram) also has the problematic spaces.

@ericfont
Copy link
Author

ericfont commented Feb 25, 2025

Note the reason why I put the link to .csv is because github does NOT render the table when the .csv file is an include in the .rst file. I'll leave it to you to figure out the best way to deal with the formatting of the tables...you make delete this PR if you wish, of course.

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.

2 participants