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: fd28fff
Choose a base ref
...
head repository: mkdocstrings/mkdocstrings
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: df4e7c8
Choose a head ref
  • 15 commits
  • 21 files changed
  • 2 contributors

Commits on Mar 10, 2025

  1. build: Depend on MkDocs 1.6

    We need version 1.6 for combined events.
    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 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 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 committed Mar 10, 2025
    Configuration menu
    Copy the full SHA
    d4c7b9c View commit details
    Browse the repository at this point in the history
  5. Configuration menu
    Copy the full SHA
    3366f5b View commit details
    Browse the repository at this point in the history
  6. 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 committed Mar 10, 2025
    Configuration menu
    Copy the full SHA
    32e415d View commit details
    Browse the repository at this point in the history

Commits on Mar 14, 2025

  1. Configuration menu
    Copy the full SHA
    ba98661 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    9464579 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    983b3cd View commit details
    Browse the repository at this point in the history

Commits on Mar 28, 2025

  1. Configuration menu
    Copy the full SHA
    ccf65c1 View commit details
    Browse the repository at this point in the history

Commits on Mar 31, 2025

  1. style: Format and configure for Ruff >= 0.10.0

    Ruff 0.10.0 introduces the S704 lint, which triggers when a non-
    literal string is passed to `markupsafe.Markup()`. This triggered
    5 times in the codebase. Only one of these errors was trivially
    fixable, and the fix caused tests to fail because the "fix"
    introduced escapes to already correct markup. This commit therefore
    configures Ruff to ignore this lint and does not fix any code that
    triggers it.
    
    Other changes are due to other formatting and linting changes from
    recent releases of Ruff.
    
    Ruff 0.10.0: https://github.com/astral-sh/ruff/releases/tag/0.10.0
    Lint S704: https://docs.astral.sh/ruff/rules/unsafe-markup-use/
    Yoshanuikabundi authored and pawamoy committed Mar 31, 2025
    Configuration menu
    Copy the full SHA
    0bc4799 View commit details
    Browse the repository at this point in the history
  2. fix: Ignore invalid inventory lines

    Previously, inventory items whose `dispname` value contains multiple lines would prevent mkdocstrings from loading the whole inventory file. This change makes mkdocstrings ignore invalid lines in inventories so that the rest of the inventory can still be loaded.
    
    This continuation line behavior can be seen in the wild in the OpenEye toolkits inventory file and a few Open Force Field inventory files. These projects' inventories cannot be used with mkdocstrings because of the raised error.
    
    Note that in Sphinx too, these inventory files are read succesfully, and the continuation lines are discarded, truncating the display name. In theory, a continuation line that by chance did parse correctly would be interpreted by both packages as a new inventory item.
    
    OpenEye Toolkits inventory file: https://docs.eyesopen.com/toolkits/python/objects.inv
    Open Force Field Toolkit inventory file:  https://docs.openforcefield.org/projects/toolkit/en/stable/objects.inv
    BespokeFit inventory file: https://docs.openforcefield.org/projects/bespokefit/en/stable/objects.inv
    Yoshanuikabundi authored and pawamoy committed Mar 31, 2025
    Configuration menu
    Copy the full SHA
    81caff5 View commit details
    Browse the repository at this point in the history
  3. Configuration menu
    Copy the full SHA
    1a98040 View commit details
    Browse the repository at this point in the history
  4. chore: Prepare release 0.29.1

    pawamoy committed Mar 31, 2025
    Configuration menu
    Copy the full SHA
    df4e7c8 View commit details
    Browse the repository at this point in the history
Loading