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

Add custom admonition for referencing other doc pages #152

Merged
merged 2 commits into from
Feb 16, 2023

Conversation

jacobtomlinson
Copy link
Member

Added a custom docref admonition to help cross-reference docs when writing.

You can link to another documentation page with a docref admonition.

```{docref} /cloud/gcp/gke
For more detailed information on launching GPU powered Kubernetes clusters on Google Cloud see the documentation.
```

Renders as:

image

Note
The Visit the documentation >> link is added automatically in the bottom right based on the page that is referenced in the directive argument.

@jacobtomlinson jacobtomlinson added improvement Improves an existing functionality sphinx Related to the Sphinx theme powering these docs labels Feb 15, 2023
@jacobtomlinson
Copy link
Member Author

I'm going to merge this because I want to use it in other PRs. If folks have review feedback we can iterate in follow-up PRs.

@jacobtomlinson jacobtomlinson merged commit 0e5113e into rapidsai:main Feb 16, 2023
@jacobtomlinson jacobtomlinson deleted the docref-admonition branch February 16, 2023 13:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improvement Improves an existing functionality sphinx Related to the Sphinx theme powering these docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant