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

feature: Backlinks #153

Open
pawamoy opened this issue Apr 26, 2024 · 0 comments
Open

feature: Backlinks #153

pawamoy opened this issue Apr 26, 2024 · 0 comments
Assignees
@pawamoy
Labels
feature New feature or request insiders Candidate for Insiders

Comments

@pawamoy
Copy link
Member

pawamoy commented Apr 26, 2024 •
edited by polar-sh bot
Loading

Is your feature request related to a problem? Please describe.

I'm having fun looking at matrix-nio's API, and also having trouble finding how to get the details of a room.

I resorted to searching for "room name" into the big HTML page, and ended up on this class: https://matrix-nio.readthedocs.io/en/latest/nio.html#nio.rooms.MatrixRoom, which seems to provide the info I want.

However I don't how I'm supposed to get back instances of this class (client.joined_rooms only returns a list of room ids as strings).

So I thought, "would be nice if there were links in this class docs showing me what functions/methods return instances of it". Backlinks!

Describe the solution you'd like

A way to display backlinks in the rendered docs:

  • For a class: which functions/methods return instances of it.
  • For anything: which functions/methods uses it. Not possible yet as we don't scan function bodies.
  • ?

Describe alternatives you've considered

Manual backlinks?

Additional context

This will probably need changes in Griffe.
@pawamoy pawamoy added the feature New feature or request label Apr 26, 2024
@pawamoy pawamoy self-assigned this Apr 26, 2024
@pawamoy pawamoy added the insiders Candidate for Insiders label Aug 20, 2024
@pawamoy pawamoy added the fund Issue priority can be boosted label Oct 22, 2024
@pawamoy pawamoy mentioned this issue Dec 20, 2024
Open
pawamoy added a commit that referenced this issue Jan 23, 2025
@pawamoy
refactor: Add backlinks metadata to autorefs elements
a4c7bec 
Issue-153: #153
pawamoy added a commit that referenced this issue Feb 4, 2025
@pawamoy
refactor: Add backlinks metadata to autorefs elements
0fd25e6 
Issue-153: #153
pawamoy added a commit that referenced this issue Feb 20, 2025
@pawamoy
refactor: Add backlinks metadata to autorefs elements
66b8898 
Issue-153: #153
@pawamoy pawamoy mentioned this issue Feb 20, 2025
Draft
pawamoy added a commit to mkdocstrings/autorefs that referenced this issue Feb 23, 2025
@pawamoy
feat: Add backlinks feature
b566031 
This feature only allows recording and retrieving backlinks, for other plugins or systems to render them. Backlinks are not rendered directly by autorefs (though we could consider offering such a feature in the future).

PR-65: #65
Issue-mkdocstrings-723: mkdocstrings/mkdocstrings#723
Issue-mkdocstrings-python-153: mkdocstrings/python#153
pawamoy added a commit to mkdocstrings/autorefs that referenced this issue Feb 23, 2025
@pawamoy
feat: Add backlinks feature
3341add 
This feature only allows recording and retrieving backlinks, for other plugins or systems to render them. Backlinks are not rendered directly by autorefs (though we could consider offering such a feature in the future).

PR-65: #65
Issue-mkdocstrings-723: mkdocstrings/mkdocstrings#723
Issue-mkdocstrings-python-153: mkdocstrings/python#153
pawamoy added a commit to mkdocstrings/autorefs that referenced this issue Feb 23, 2025
@pawamoy
feat: Add backlinks feature
d91fc17 
This feature only allows recording and retrieving backlinks, for other plugins or systems to render them. Backlinks are not rendered directly by autorefs (though we could consider offering such a feature in the future).

PR-65: #65
Issue-mkdocstrings-723: mkdocstrings/mkdocstrings#723
Issue-mkdocstrings-python-153: mkdocstrings/python#153
pawamoy added a commit to mkdocstrings/autorefs that referenced this issue Feb 23, 2025
@pawamoy
feat: Add backlinks feature
a07a391 
This feature only allows recording and retrieving backlinks, for other plugins or systems to render them. Backlinks are not rendered directly by autorefs (though we could consider offering such a feature in the future).

PR-65: #65
Issue-mkdocstrings-723: mkdocstrings/mkdocstrings#723
Issue-mkdocstrings-python-153: mkdocstrings/python#153
pawamoy added a commit to mkdocstrings/autorefs that referenced this issue Feb 23, 2025
@pawamoy
feat: Add backlinks feature
5a3b387 
This feature only allows recording and retrieving backlinks, for other plugins or systems to render them. Backlinks are not rendered directly by autorefs (though we could consider offering such a feature in the future).

PR-65: #65
Issue-mkdocstrings-723: mkdocstrings/mkdocstrings#723
Issue-mkdocstrings-python-153: mkdocstrings/python#153
pawamoy added a commit that referenced this issue Feb 24, 2025
@pawamoy
feat: Support backlinks
e810784 
Issue-153: #153
pawamoy added a commit to mkdocstrings/mkdocstrings that referenced this issue Feb 24, 2025
@pawamoy
feat: Support rendering backlinks through handlers
b9b7d1e 
Handlers must add `backlinks` HTML elements to their templates:

```html
<backlinks identifier="some-id" handler="handler-name" />
```

mkdocstrings will run a regular expression substitution on each page's HTML, and call corresponding handlers' `render_backlinks` method with backlinks fetched from autorefs (using the specified identifier, and aliases obtained thanks to it through the same handler).

Issue-723: #723
Issue-mkdocstrings-python-153: mkdocstrings/python#153
PR-739: #739
pawamoy added a commit to mkdocstrings/mkdocstrings that referenced this issue Feb 24, 2025
@pawamoy
feat: Support rendering backlinks through handlers
065f661 
Handlers must add `backlinks` HTML elements to their templates:

```html
<backlinks identifier="some-id" handler="handler-name" />
```

mkdocstrings will run a regular expression substitution on each page's HTML, and call corresponding handlers' `render_backlinks` method with backlinks fetched from autorefs (using the specified identifier, and aliases obtained thanks to it through the same handler).

Issue-723: #723
Issue-mkdocstrings-python-153: mkdocstrings/python#153
PR-739: #739
pawamoy added a commit to mkdocstrings/mkdocstrings that referenced this issue Feb 24, 2025
@pawamoy
feat: Support rendering backlinks through handlers
7f12a9e 
Handlers must add `backlinks` HTML elements to their templates:

```html
<backlinks identifier="some-id" handler="handler-name" />
```

mkdocstrings will run a regular expression substitution on each page's HTML, and call corresponding handlers' `render_backlinks` method with backlinks fetched from autorefs (using the specified identifier, and aliases obtained thanks to it through the same handler).

Issue-723: #723
Issue-mkdocstrings-python-153: mkdocstrings/python#153
PR-739: #739
pawamoy added a commit to mkdocstrings/mkdocstrings that referenced this issue Feb 24, 2025
@pawamoy
feat: Support rendering backlinks through handlers
dd69005 
Handlers must add `backlinks` HTML elements to their templates:

```html
<backlinks identifier="some-id" handler="handler-name" />
```

mkdocstrings will run a regular expression substitution on each page's HTML, and call corresponding handlers' `render_backlinks` method with backlinks fetched from autorefs (using the specified identifier, and aliases obtained thanks to it through the same handler).

Issue-723: #723
Issue-mkdocstrings-python-153: mkdocstrings/python#153
PR-739: #739
pawamoy added a commit that referenced this issue Feb 28, 2025
@pawamoy
feat: Support backlinks
5ab3405 
Issue-153: #153
@pawamoy pawamoy removed the fund Issue priority can be boosted label Mar 2, 2025
pawamoy added a commit to mkdocstrings/mkdocstrings that referenced this issue Mar 8, 2025
@pawamoy
feat: Support rendering backlinks through handlers
a193707 
Handlers must add `backlinks` HTML elements to their templates:

```html
<backlinks identifier="some-id" handler="handler-name" />
```

mkdocstrings will run a regular expression substitution on each page's HTML, and call corresponding handlers' `render_backlinks` method with backlinks fetched from autorefs (using the specified identifier, and aliases obtained thanks to it through the same handler).

Issue-723: #723
Issue-mkdocstrings-python-153: mkdocstrings/python#153
PR-739: #739
pawamoy added a commit that referenced this issue Mar 8, 2025
@pawamoy
feat: Support backlinks
2bf0cc0 
Issue-153: #153
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pawamoy pawamoy

Labels
feature New feature or request insiders Candidate for Insiders
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pawamoy