Skip to content

Resolve params in text#311

Merged
mariosasko merged 3 commits into
mainfrom
resolve-params-in-text
Oct 7, 2022
Merged

Resolve params in text#311
mariosasko merged 3 commits into
mainfrom
resolve-params-in-text

Conversation

@mariosasko

Copy link
Copy Markdown
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)

@sgugger sgugger left a comment

Copy link
Copy Markdown
Contributor

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.

Comment thread src/doc_builder/autodoc.py Outdated
Comment thread tests/test_autodoc.py

@sgugger sgugger left a comment

Copy link
Copy Markdown
Contributor

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants