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

docs/contents: use captions in the global toc #366

Draft
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

umarcor
Copy link
Collaborator

@umarcor umarcor commented Apr 19, 2022

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Apr 19, 2022
@umarcor umarcor force-pushed the umarcor/docs/structure branch 11 times, most recently from 26114c3 to 798b9e2 Compare April 21, 2022 08:06
@umarcor umarcor marked this pull request as ready for review April 21, 2022 08:07
@umarcor umarcor changed the title docs/contents: use toctree with caption docs/contents: use captions in the global toc Apr 21, 2022
@umarcor umarcor force-pushed the umarcor/docs/structure branch 2 times, most recently from 8768fe5 to 021235b Compare April 23, 2022 23:57
@umarcor umarcor requested a review from mithro April 24, 2022 00:03
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'm a little bit confused why there are so many files being deleted?

@umarcor
Copy link
Collaborator Author

umarcor commented Apr 25, 2022

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 index.rst. As a result, the captions are properly processed (and shown).

On the other hand, there are several files which contain a single title starting with TODO. I changed all of those to a .. todo:: directive, which is more idiomatic in the context of Sphinx.

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.

@mithro
Copy link
Contributor

mithro commented Apr 25, 2022

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?

@proppy
Copy link
Member

proppy commented Jul 1, 2022

@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:
https://skywater-pdk.readthedocs.io/en/main/rules/hv.html
Becomes nested under:
https://skywater-pdk--366.org.readthedocs.build/en/366/rules/methodologies/index.html
Thus rendering the previous url 404.

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

@proppy proppy added the type-enhancement New feature or request label Jul 1, 2022
@proppy proppy self-requested a review July 1, 2022 07:33
Signed-off-by: Unai Martinez-Corral <[email protected]>
Signed-off-by: Unai Martinez-Corral <[email protected]>
Signed-off-by: Unai Martinez-Corral <[email protected]>
Signed-off-by: Unai Martinez-Corral <[email protected]>
Signed-off-by: Unai Martinez-Corral <[email protected]>
Signed-off-by: Unai Martinez-Corral <[email protected]>
Signed-off-by: Unai Martinez-Corral <[email protected]>
Signed-off-by: Unai Martinez-Corral <[email protected]>
Signed-off-by: Unai Martinez-Corral <[email protected]>
Signed-off-by: Unai Martinez-Corral <[email protected]>
Signed-off-by: Unai Martinez-Corral <[email protected]>
Signed-off-by: Unai Martinez-Corral <[email protected]>
Signed-off-by: Unai Martinez-Corral <[email protected]>
@umarcor umarcor marked this pull request as draft August 21, 2022 00:29
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 type-enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants