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

Strip prefix paths to improve doc rendering #1954

Merged
merged 4 commits into from
Jul 8, 2024

Conversation

bdice
Copy link
Contributor

@bdice bdice commented Jul 8, 2024

Description

Resolves #1953.

Before

image

After

image

Checklist

  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

Sorry, something went wrong.

bdice added 2 commits July 7, 2024 17:44

Verified

This commit was signed with the committer’s verified signature.
miscco Michael Schellenberger Costa

Verified

This commit was signed with the committer’s verified signature.
miscco Michael Schellenberger Costa
@bdice bdice requested review from a team as code owners July 8, 2024 00:50
@bdice bdice requested review from miscco and ericniebler July 8, 2024 00:50
@bdice bdice changed the title Fix docs paths Strip prefix paths to improve doc rendering Jul 8, 2024
@@ -9,5 +9,4 @@ Pair
:glob:
:maxdepth: 1

${repo_docs_api_path}/*typedef_group__pair*
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I get this error unless I remove this line:

/.../cccl/docs/thrust/api_docs/utility/pair.rst:8: WARNING: toctree glob pattern '/api/*typedef_group__pair*' didn't match any documents

Copy link
Contributor

@bernhardmgruber bernhardmgruber Jul 8, 2024

Choose a reason for hiding this comment

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

I get the same error locally (Ubuntu 24.04), but the CI seems to be fine. It could be a version mismatch somewhere. Do you get the error locally, in a devcontainer, or from the CI?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Weird. I see that page being written in CI builds. I’ll revert this.

bdice added 2 commits July 8, 2024 06:05

Verified

This commit was signed with the committer’s verified signature.
miscco Michael Schellenberger Costa

Verified

This commit was signed with the committer’s verified signature.
@bernhardmgruber bernhardmgruber merged commit 34c7f5e into NVIDIA:main Jul 8, 2024
13 of 17 checks passed
@bernhardmgruber bernhardmgruber added the doc Documentation-related items. label Jul 8, 2024
caugonnet added a commit to caugonnet/cccl that referenced this pull request Oct 21, 2024

Verified

This commit was signed with the committer’s verified signature.
Strip prefix paths from cudax documentation
miscco pushed a commit that referenced this pull request Oct 21, 2024
Strip prefix paths from cudax documentation
pciolkosz pushed a commit to pciolkosz/cccl that referenced this pull request Oct 25, 2024
Strip prefix paths from cudax documentation
fbusato pushed a commit to fbusato/cccl that referenced this pull request Nov 5, 2024
Strip prefix paths from cudax documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation-related items.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

[DOC]: CI runner paths appear in rendered docs
2 participants