huggingface / huggingface/doc-builder

Markdown link not rendered correctly in a "<Tip>" section

Open
#314 2 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
Python
Stars
144
Forks
59
Avg merge
2d 5h
Merged PRs (30d)
13

Description

### Is your feature request related to a problem? Please describe.
When using the ` (...) ` syntax, links are generated but not displayed properly in the UI.

Here is an example where it happens: https://huggingface.co/docs/huggingface_hub/main/en/package_reference/login.
I define a link in the docstring using the "[`login`]" syntax which is converted into a markdown link `"[login()](/docs/huggingface_hub/main/en/package_reference/login#huggingface_hub.login)"` but the rendering fails to display it as a link.

#### Original docstring:
```text

[`login`] is a drop-in replacement method for [`notebook_login`] as it wraps and
extends its capabilities.

```

#### Generated doc:

```text
[login()](/docs/huggingface_hub/main/en/package_reference/login#huggingface_hub.login) is a drop-in replacement method for [notebook_login()](/docs/huggingface_hub/main/en/package_reference/login#huggingface_hub.notebook_login) as it wraps and extends its capabilities.
```

#### Rendering:

![login_doc](https://user-images.githubusercontent.com/11801849/196224706-0186bcbe-4256-45ad-9718-750c1275ce3c.png)

### Describe the solution you'd like
Would love to the a proper clickable link in a Tip section :)

### Describe alternatives you've considered
I can remove the link in the Tip section if that's too complicated to fix.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.