-
Notifications
You must be signed in to change notification settings - Fork 382
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
Generating resources.rst from Google Spreadsheet #255
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would like to see a copy of the rendered rst file included in the readthedocs preview output so I can confirm it looks okay.
scripts/python-skywater-pdk/skywater_pdk/generate-resources-rst.py
Outdated
Show resolved
Hide resolved
scripts/python-skywater-pdk/skywater_pdk/generate-resources-rst.py
Outdated
Show resolved
Hide resolved
scripts/python-skywater-pdk/skywater_pdk/generate-resources-rst.py
Outdated
Show resolved
Hide resolved
scripts/python-skywater-pdk/skywater_pdk/generate-resources-rst.py
Outdated
Show resolved
Hide resolved
scripts/python-skywater-pdk/skywater_pdk/generate-resources-rst.py
Outdated
Show resolved
Hide resolved
@@ -3,6 +3,7 @@ flake8 | |||
# rst_include tool as GitHub doesn't support `.. include::` when rendering | |||
# previews. | |||
rst_include | |||
pandas |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pandas seems a rather heavy dependency here? As pandas is a binary dependency it should probably also be in the environment.yml
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I used pandas to simplify accessing row fields. If pandas is too heavy I can replace it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I put pandas
in requirements.txt
in case someone would like to install the required pip
packages for skywater-pdk without using conda
environment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I also used pandas to read Google spreadsheet files directly from URL
@@ -0,0 +1,160 @@ | |||
#!/usr/bin/env python3 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm wondering if this should just be part of the sphinx documentation?
When does this tool run? Should it be run as part of building the documentation or as a scheduled github action (with the results committed to the repository)?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
my idea was that this script should be executed like separately like rest of the generating scripts.
Here is the preview as for now: https://skywater-pdk--255.org.readthedocs.build/en/255/resources.html |
BTW I think the data is starting to get there, but we need someone to make this page look beautiful :-) -- Maybe the rendered output should be a table rather than a list? |
scripts/python-skywater-pdk/skywater_pdk/generate-resources-rst.py
Outdated
Show resolved
Hide resolved
…adsheet Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
…rted spreadsheets Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
…rguments Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
…ources_rst.py Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
Signed-off-by: Grzegorz Latosinski <glatosinski@antmicro.com>
6a7fd59
to
064b239
Compare
Fixes #189
This PR adds a script that takes XLSX file (or publicly available Google Spreadsheet ID) and generates resources.rst file from its contents. The sample spreadsheet that can be parsed by the script is available in https://docs.google.com/spreadsheets/d/1tOU0N0qMeDFjTz9NrGz_-PBikgu2x2gDHezy2SlE9dA/edit#gid=0