docs/contents: use captions in the global toc#366
docs/contents: use captions in the global toc#366umarcor wants to merge 16 commits intogoogle:mainfrom
Conversation
26114c3 to
798b9e2
Compare
8768fe5 to
021235b
Compare
mithro
left a comment
There was a problem hiding this comment.
I'm a little bit confused why there are so many files being deleted?
In the current "main" there is one file for each "chapter" which includes a toctree only with a caption. For instance: https://github.com/google/skywater-pdk/blob/main/docs/analog.rst. In those cases, the caption is "useless" because it's not shown in the sidebar. In this PR, I move all of those "second level toctrees" into the On the other hand, there are several files which contain a single title starting with TODO. I changed all of those to a Last, a few files did have more than one top-level heading. In those cases, I split the content to have one top-level heading per file. |
|
Random comment -- Should the "Foundry provided" libraries (https://skywater-pdk--366.org.readthedocs.build/en/366/contents/libraries/foundry-provided.html) and IO cells (https://skywater-pdk--366.org.readthedocs.build/en/366/contents/libraries/sky130_fd_io/README.html) appear in the "PDK Contents" section on the left? |
|
@umarcor thanks for working on this, this really improve the navigation experience a lot! One potential concerns, wouldn't removing the standalone rst files in favor of "including them" break some existing links to those pages? Ex: It also seems that we loose some granulary in the left nav (in favor of moving the element as section in the right nav), and I just want to make sure that's a conscious choice (as it does affect the discoverability of those elements). |
021235b to
4496e93
Compare
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
Signed-off-by: Unai Martinez-Corral <umartinezcorral@antmicro.com>
4496e93 to
6b9b570
Compare
Fix for f4pga/sphinx_f4pga_theme#11