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

Generating resources.rst from Google Spreadsheet #255

Open
wants to merge 13 commits into
base: main
Choose a base branch
from

Conversation

glatosinski
Copy link
Collaborator

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

Copy link
Contributor

@mithro mithro left a 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.

@@ -3,6 +3,7 @@ flake8
# rst_include tool as GitHub doesn't support `.. include::` when rendering
# previews.
rst_include
pandas
Copy link
Contributor

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?

Copy link
Collaborator Author

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.

Copy link
Collaborator Author

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.

Copy link
Collaborator Author

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
Copy link
Contributor

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)?

Copy link
Collaborator Author

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.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 24, 2020
@glatosinski
Copy link
Collaborator Author

Here is the preview as for now: https://skywater-pdk--255.org.readthedocs.build/en/255/resources.html

@mithro
Copy link
Contributor

mithro commented Nov 24, 2020

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Consider putting resources information into a spreadsheet
2 participants