Skip to content
Permalink

Comparing changes

Choose two branches to see what’s changed or to start a new pull request. If you need to, you can also or learn more about diff comparisons.

Open a pull request

Create a new pull request by comparing changes across two branches. If you need to, you can also . Learn more about diff comparisons here.
base repository: mkdocstrings/mkdocstrings
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 0.28.3
Choose a base ref
...
head repository: mkdocstrings/mkdocstrings
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: 0.29.0
Choose a head ref
  • 7 commits
  • 6 files changed
  • 1 contributor

Commits on Mar 10, 2025

  1. build: Depend on MkDocs 1.6 

    We need version 1.6 for combined events.
    @pawamoy
    pawamoy committed Mar 10, 2025
    Configuration menu
    Copy the full SHA
    11bc400 View commit details
    Browse the repository at this point in the history

  2. refactor: Use a combined event (each split with a different priority)… 

    … for `on_env`

This is required because we must run things in `on_env` *before* autorefs, and the backlinks feature will need to run things *after* autorefs.
    @pawamoy
    pawamoy committed Mar 10, 2025
    Configuration menu
    Copy the full SHA
    8d1dd75 View commit details
    Browse the repository at this point in the history

  3. refactor: Save and forward titles to autorefs 

    This will be useful for the backlinks feature.

Additionally, use autorefs `current_page` as a `Page` object, not a string (URL).
    @pawamoy
    pawamoy committed Mar 10, 2025
    Configuration menu
    Copy the full SHA
    f49fb29 View commit details
    Browse the repository at this point in the history

  4. feat: Support rendering backlinks through handlers 

    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
    pawamoy committed Mar 10, 2025
    Configuration menu
    Copy the full SHA
    d4c7b9c View commit details
    Browse the repository at this point in the history

  5. docs: Escape <p> in docstrings

    @pawamoy
    pawamoy committed Mar 10, 2025
    Configuration menu
    Copy the full SHA
    3366f5b View commit details
    Browse the repository at this point in the history

  6. Merge branch 'main' of github.com:mkdocstrings/mkdocstrings

    @pawamoy
    pawamoy committed Mar 10, 2025
    Configuration menu
    Copy the full SHA
    44462d0 View commit details
    Browse the repository at this point in the history

  7. chore: Prepare release 0.29.0

    @pawamoy
    pawamoy committed Mar 10, 2025
    Configuration menu
    Copy the full SHA
    32e415d View commit details
    Browse the repository at this point in the history
Loading