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

Link to @!group sections? #1596

Open
thomthom opened this issue Dec 17, 2024 · 1 comment
Open

Link to @!group sections? #1596

thomthom opened this issue Dec 17, 2024 · 1 comment

Comments

@thomthom
Copy link
Contributor

Given a @!group section, is it possible to refer to it elsewhere in the documentation such that it creates a link to it?

Or even some means of manually creating a link?

For instance, a group of constants that refer to possible return values of a method. Can the method doc somehow link to the group?

@thomthom
Copy link
Contributor Author

To answer my own question:

Given a group @!group Hello World

I can link to it like so:

{Link to Hello World}[#hello_world]:

At least this works when the group is defined in the same context I'm referencing it. (On the same page).
Not sure how to link to a group on another page though.

I could put up a PR with example to how to link to groups in the Tags Overview if that's of any interest.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant