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

Improve the tables of content #1852

Merged
merged 10 commits into from
Sep 20, 2024
Merged

Improve the tables of content #1852

merged 10 commits into from
Sep 20, 2024

Conversation

akukanov
Copy link
Contributor

@akukanov akukanov commented Sep 17, 2024

The patch restructures the table of content to better organized documentation topics. It also does related minor changes such as page reordering and title modifications.

@akukanov akukanov force-pushed the dev/doc-improve-toctree-akukanov branch from 89b1cd7 to 2a8527b Compare September 17, 2024 18:13
@akukanov akukanov marked this pull request as ready for review September 19, 2024 13:45
@akukanov akukanov added this to the 2022.7.0 milestone Sep 19, 2024
@timmiesmith
Copy link
Contributor

@akukanov #1830 shows how to expand the TOC in the left pane so that it shows something with a similar expansion to what we see in the main pane with this PR.

documentation/library_guide/index.rst Outdated Show resolved Hide resolved
documentation/library_guide/index.rst Outdated Show resolved Hide resolved
documentation/library_guide/index.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@timmiesmith timmiesmith left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with Mike's suggestion and only have one additional question myself.

@akukanov
Copy link
Contributor Author

@akukanov #1830 shows how to expand the TOC in the left pane so that it shows something with a similar expansion to what we see in the main pane with this PR.

@timmiesmith @dcbenito - I have merged that change here to take a look, but then reverted. Let's consider it later, separately from the restructuring.

Comment on lines 19 to 20
api_for_sycl_kernels/tested_standard_cpp_api
api_for_sycl_kernels/utility_function_object_classes No newline at end of file
api_for_sycl_kernels/random
api_for_sycl_kernels/utility_function_object_classes
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The topics are reordered to match the description at the page above, It makes more sense for the chain of "Next" links that are also generated from TOC.

Copy link
Contributor

@timmiesmith timmiesmith 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 to me. Thank you.

Copy link
Contributor

@dcbenito dcbenito left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@akukanov akukanov merged commit b73422d into main Sep 20, 2024
22 checks passed
@akukanov akukanov deleted the dev/doc-improve-toctree-akukanov branch September 20, 2024 10:41
mmichel11 pushed a commit that referenced this pull request Sep 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants