skywater-pdk
skywater-pdk copied to clipboard
google
docs: Add generator for cell index
This script creates list of cells in each library.
Addressing #86 .
Thanks for your pull request. It looks like this may be your first contribution to a Google open source project (if not, look below for help). Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).
:memo: Please visit https://cla.developers.google.com/ to sign.
Once you've signed (or fixed any issues), please reply here with @googlebot I signed it! and we'll verify it.
What to do if you already signed the CLA
Individual signers
- It's possible we don't have your GitHub username or you're using a different email address on your commit. Check your existing CLA data and verify that your email is set on your git commits.
Corporate signers
- Your company has a Point of Contact who decides which employees are authorized to participate. Ask your POC to be added to the group of authorized contributors. If you don't know who your Point of Contact is, direct the Google project maintainer to go/cla#troubleshoot (Public version).
- The email used to register you as an authorized contributor must be the email used for the Git commit. Check your existing CLA data and verify that your email is set on your git commits.
- The email used to register you as an authorized contributor must also be attached to your GitHub account.
ℹ️ Googlers: Go here for more info.
![google-cla[bot] avatar](https://avatars.githubusercontent.com/in/42202?v=4 "Published by a pub.dev verified publisher"){kind=small}
Should I commit changed README.rst files in libraries? I added this line to each
.. include:: cell-list.rst
Another update @mithro.
I tend to keep configuration like the rst templates etc at top level, as this is the first thing a user will want to change when altering the resulting rst, but it can be adjusted as you prefer.
How to proceed with changes to README.rst?
FYI - There is a manually generated spreadsheet at https://docs.google.com/spreadsheets/d/1KMZ215M_7YQb0l-vCyVdzSsRzaSJN4VVGsTwf4wFK3k/edit#gid=139199577
At the moment, you don't get any output in the documentation. We need to figure out how to make run on readthedocs (or an alternative way to push things to readthedocs).
We would like to add a local sphinx extension to generate the list of cells for each library.
@pkatarzynski -- If we can figure out the right way to make the ReadTheDocs builder clone the submodules which contain the cells, they should just all start appearing in the documentation? One potential issue is that the builder might run out of disk space...
Another option is to run the tool as part of the generation of the library repositories?
@mithro were the concern you had back in https://github.com/google/skywater-pdk/pull/143#issuecomment-721942430 addressed by follow up commits: https://github.com/google/skywater-pdk/pull/143/commits/b211454ddb4b0d6f8b145da94924c2dafa30d35e https://github.com/google/skywater-pdk/pull/143/commits/8e9a17a8659352ce5fdee81a89d704a8fc8cb76e ?
@kgugala - Should this index be appearing in the docs @ https://skywater-pdk--143.org.readthedocs.build/en/143/ somewhere?
@kgugala do you know if readthedocs got updated as part of your rebase, or does that needs to be done separatly (if the later, can you share the instructions?)
@proppy the RTD build was/is triggered automatically. See the checks below (click on "Show all checks"). That will take you to the link that @mithro posted. On the bottom right, there is a floating box with a link to https://readthedocs.org/projects/skywater-pdk/builds/.
I was able to find the RTD logs https://readthedocs.org/api/v2/build/16966503.txt thanks to the instructions @umarcor provided.
@kgugala @PiotrZierhoffer there doesn't seems to be any call to the cell_list directive that gets added w/ this PR, was there anything else that was done in https://antmicro-skywater-pdk-docs.readthedocs.io/en/test-submodules-in-rtd/contents/libraries/sky130_fd_sc_hd/README.html in order to populate the table?