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.

Sign up for GitHub

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

Jump to bottom

Resolve params in text #311

Merged
merged 3 commits into from
Oct 7, 2022
Merged

Resolve params in text #311

merged 3 commits into from
Oct 7, 2022

Conversation

mariosasko
Copy link
Contributor

Resolve function/method parameter links in MD/MDX files.

This is the syntax for the parameter links:

[`package.module.function#parameter`]

And this is what's left after the resolution step:

[parameter](url_with_function#package.module.function.parameter)

@mariosasko mariosasko mentioned this pull request Oct 7, 2022
Merged
sgugger
sgugger reviewed Oct 7, 2022
View reviewed changes
Copy link
Contributor

@sgugger sgugger left a comment

Choose a reason for hiding this comment

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

Thanks a lot for working on this! I think the case combining a ~ and a # should be supported.

src/doc_builder/autodoc.py Outdated Show resolved Hide resolved
tests/test_autodoc.py Outdated Show resolved Hide resolved
sgugger
sgugger approved these changes Oct 7, 2022
View reviewed changes
Copy link
Contributor

@sgugger sgugger left a comment

Choose a reason for hiding this comment

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

Thanks a lot!

@mariosasko mariosasko merged commit 34a94a3 into main Oct 7, 2022
@mariosasko mariosasko deleted the resolve-params-in-text branch October 7, 2022 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sgugger sgugger sgugger approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mariosasko @sgugger