-
Notifications
You must be signed in to change notification settings - Fork 383
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
docs: Add generator for cell index #143
base: main
Are you sure you want to change the base?
Conversation
This comment has been minimized.
This comment has been minimized.
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.
Looks good! Just some minor comments.
default=False) | ||
|
||
args = parser.parse_args() | ||
if args.debug: |
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.
Seems like debug
isn't all that used. Maybe we should get rid of 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.
Are we ok with the script printing stuff on its own? Or should it be silent?
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 left unconditional printing, can be removed if needed
a8096c3
to
d6da333
Compare
Should I commit changed README.rst files in libraries? I added this line to each
|
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.
Just a couple of minor whitespace fixes.
Can you squash your commits together too?
9886dae
to
d9d65d8
Compare
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 |
@PiotrZierhoffer - This pull request needs a rebase before I can merge it. |
539f237
to
7a68ca1
Compare
The PR has been rebased @mithro PTAL |
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? |
This addresses google#86 Signed-off-by: Piotr Zierhoffer <pzierhoffer@antmicro.com>
I have rebased this and resolved conflicts. @proppy can we land this? |
@mithro were the concern you had back in #143 (comment) addressed by follow up commits: b211454 8e9a17a ? |
@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 |
Looks like some work was done around this in #266 too. |
and #256 too. |
This script creates list of cells in each library.
Addressing #86 .