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.

Sign up for GitHub

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

Jump to bottom

docs: Add generator for cell index #143

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

docs: Add generator for cell index #143

wants to merge 2 commits into from

Conversation

PiotrZierhoffer
Copy link
Collaborator

This script creates list of cells in each library.

Addressing #86 .

@google-cla

This comment has been minimized.

Sign in to view
mithro
mithro reviewed Aug 25, 2020
View reviewed changes
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.

Looks good! Just some minor comments.

scripts/python-skywater-pdk/skywater_pdk/cell_list.py Outdated Show resolved Hide resolved
scripts/python-skywater-pdk/skywater_pdk/cell_list.py Outdated Show resolved Hide resolved
scripts/python-skywater-pdk/skywater_pdk/cell_list.py Outdated Show resolved Hide resolved
scripts/python-skywater-pdk/skywater_pdk/cell_list.py Outdated Show resolved Hide resolved
scripts/python-skywater-pdk/skywater_pdk/cell_list.py Outdated Show resolved Hide resolved
scripts/python-skywater-pdk/skywater_pdk/cell_list.py Outdated
default=False)

args = parser.parse_args()
if args.debug:
Copy link
Contributor

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?

Copy link
Collaborator Author

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?

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 left unconditional printing, can be removed if needed

@PiotrZierhoffer PiotrZierhoffer force-pushed the 86-cell_index branch 2 times, most recently from a8096c3 to d6da333 Compare August 26, 2020 09:01
@PiotrZierhoffer
Copy link
Collaborator Author

Should I commit changed README.rst files in libraries? I added this line to each

.. include:: cell-list.rst

mithro
mithro approved these changes Aug 26, 2020
View reviewed changes
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.

Just a couple of minor whitespace fixes.

Can you squash your commits together too?

scripts/python-skywater-pdk/skywater_pdk/cell_list.py Outdated Show resolved Hide resolved
scripts/python-skywater-pdk/skywater_pdk/cell_list.py Outdated Show resolved Hide resolved
scripts/python-skywater-pdk/skywater_pdk/cell_list.py Outdated Show resolved Hide resolved
docs/conf.py Show resolved Hide resolved
@PiotrZierhoffer PiotrZierhoffer force-pushed the 86-cell_index branch 2 times, most recently from 9886dae to d9d65d8 Compare August 26, 2020 16:49
@PiotrZierhoffer
Copy link
Collaborator Author

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?

@mithro mithro mentioned this pull request Oct 22, 2020
Closed
@mithro mithro added documentation Improvements or additions to documentation lib-sky130_fd_io Issues with the IO and periphery cells provided by the SkyWater foundry. lib-sky130_fd_pr Issues with the base primitive cells provided by the SkyWater foundry. lib-sky130_fd_sc_hd Issues with the "high density" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hdll Issues with the "high density low leakage" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hs Issues with the "high speed" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_ms Issues with the "medium speed" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_ls Issues with the "low speed" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_lp Issues with the "low power" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hvl Issues with the "high voltage" digital standard cells provided by the SkyWater foundry. lib-sky130_osu_sc Issues with the digital standard cells provided by Oklahoma State University. scripts-documentation Issues with the scripts involved in the PDK documentation generation. labels Oct 22, 2020
@mithro
Copy link
Contributor

mithro commented Oct 22, 2020

FYI - There is a manually generated spreadsheet at https://docs.google.com/spreadsheets/d/1KMZ215M_7YQb0l-vCyVdzSsRzaSJN4VVGsTwf4wFK3k/edit#gid=139199577

@mithro
Copy link
Contributor

mithro commented Oct 22, 2020

@PiotrZierhoffer - This pull request needs a rebase before I can merge it.

@wgryncewicz wgryncewicz force-pushed the 86-cell_index branch 2 times, most recently from 539f237 to 7a68ca1 Compare November 3, 2020 11:07
@pkatarzynski
Copy link
Collaborator

The PR has been rebased @mithro PTAL

@mithro
Copy link
Contributor

mithro commented Nov 3, 2020

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

@pkatarzynski
Copy link
Collaborator

We would like to add a local sphinx extension to generate the list of cells for each library.

@mithro
Copy link
Contributor

mithro commented Nov 4, 2020

@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...

@mithro
Copy link
Contributor

mithro commented Nov 4, 2020

Another option is to run the tool as part of the generation of the library repositories?

PiotrZierhoffer and others added 2 commits May 20, 2022 16:21
@PiotrZierhoffer @kgugala
docs: Add generator for cell index
b211454 
This addresses google#86

Signed-off-by: Piotr Zierhoffer <pzierhoffer@antmicro.com>
@wgryncewicz @kgugala
cell_index wrapped as Sphinx extension
8e9a17a
@github-actions github-actions bot removed lib-sky130_fd_sc_ls Issues with the "low speed" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hdll Issues with the "high density low leakage" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hd Issues with the "high density" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hvl Issues with the "high voltage" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_ms Issues with the "medium speed" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_hs Issues with the "high speed" digital standard cells provided by the SkyWater foundry. lib-sky130_fd_sc_lp Issues with the "low power" digital standard cells provided by the SkyWater foundry. lib-sky130_osu_sc Issues with the digital standard cells provided by Oklahoma State University. labels May 20, 2022
@kgugala
Copy link
Contributor

kgugala commented May 20, 2022

I have rebased this and resolved conflicts. @proppy can we land this?

@proppy
Copy link
Member

proppy commented May 24, 2022

@mithro were the concern you had back in #143 (comment) addressed by follow up commits: b211454 8e9a17a ?

@mithro
Copy link
Contributor

mithro commented May 24, 2022

@kgugala - Should this index be appearing in the docs @ https://skywater-pdk--143.org.readthedocs.build/en/143/ somewhere?

@proppy
Copy link
Member

proppy commented May 24, 2022

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

@umarcor
Copy link
Collaborator

umarcor commented May 24, 2022 •
edited
Loading

@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/.

@proppy
Copy link
Member

proppy commented May 30, 2022

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?

@proppy
Copy link
Member

proppy commented May 30, 2022

Looks like some work was done around this in #266 too.

@proppy
Copy link
Member

proppy commented May 30, 2022

and #256 too.

@proppy proppy mentioned this pull request Jul 1, 2022
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mithro mithro mithro approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation lib-sky130_fd_io Issues with the IO and periphery cells provided by the SkyWater foundry. lib-sky130_fd_pr Issues with the base primitive cells provided by the SkyWater foundry. scripts-documentation Issues with the scripts involved in the PDK documentation generation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@PiotrZierhoffer @mithro @pkatarzynski @kgugala @proppy @umarcor @wgryncewicz