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

Make at-ref links more flexible #1900

Merged
merged 3 commits into from
Aug 23, 2022
Merged

Make at-ref links more flexible #1900

merged 3 commits into from
Aug 23, 2022

Conversation

mortenpi
Copy link
Member

@mortenpi mortenpi commented Aug 9, 2022

Allows at-ref links of the form

[the function `g`](@ref MyPackage.g)
[something-something](@ref "Section On Something")

which were previously not allowed. Previously you were only allowed to link either to an existing id (e.g. created by at-id, or by Documenter itself from a heading), or link to a docstring, but only if the whole label was code.

Fix #781, close #1767.

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.

Using @ref macro for a specific method's docstring Allow named @ref to docstrings without backticks
1 participant