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/python
Failed to load repositories. Confirm that selected base ref is valid, then try again.
Loading
base: 1670ecb
Choose a base ref
...
head repository: mkdocstrings/python
Failed to load repositories. Confirm that selected head ref is valid, then try again.
Loading
compare: c888dc2
Choose a head ref
  • 15 commits
  • 19 files changed
  • 6 contributors

Commits on Jul 8, 2026

  1. chore: Update sponsors section in README (#332)

    Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
    github-actions[bot] and github-actions[bot] authored Jul 8, 2026
    Configuration menu
    Copy the full SHA
    0fa2d2e View commit details
    Browse the repository at this point in the history

Commits on Aug 7, 2026

  1. fix: Increase stash key length from 1 to 2

    Cross-reference stash keys start with `_` and preserve the rendered identifier length. One-character and two-character identifiers therefore share a keyspace of only 62 keys. Once all keys are present, `_gen_stash_key` retries random choices forever. This happens for example in mkdocstrings when rendering an attribute value that has 62 names in it or more. We increase the minimum key length by 1, to reach a keyspace of 3844, making it very unlikely to hit the limit again.
    
    PR-336: #336
    jonashaag authored Aug 7, 2026
    Configuration menu
    Copy the full SHA
    6ff2749 View commit details
    Browse the repository at this point in the history

Commits on Aug 16, 2026

  1. Configuration menu
    Copy the full SHA
    4b38b6b View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    bb49b15 View commit details
    Browse the repository at this point in the history
  3. ci: Fix type-checking issues

    pawamoy committed Aug 16, 2026
    Configuration menu
    Copy the full SHA
    3c782f5 View commit details
    Browse the repository at this point in the history
  4. chore: Prepare release 2.0.6

    pawamoy committed Aug 16, 2026
    Configuration menu
    Copy the full SHA
    a025f49 View commit details
    Browse the repository at this point in the history

Commits on Aug 17, 2026

  1. fix: Don't render environment paths in source block labels

    When an object's file lives in a virtual environment inside the current working directory (for example a pydantic `BaseModel` subclass documented with `preload_modules: [pydantic]` and an in-project `.venv`), source blocks were labeled with the environment path, like `.venv/lib/python3.10/site-packages/pydantic/main.py`.
    
    The path is relative to the current working directory, so it slipped past the `is_absolute()` check that normally keeps environment paths out of rendered docs.
    
    Add a `source_location` filter that strips everything up to and including a `site-packages` directory from displayed source paths, and use it for every source block label: merged `__init__`, class, and function, in both themes. 
    
    Centralizing the logic also fixes the label for single-file modules installed directly in `site-packages` (like `six.py`), whose package-relative path still contained the environment directory. Labels of objects belonging to the documented package itself are unchanged.
    
    Issue-333: #333
    PR-338: #338
    cdwilson authored Aug 17, 2026
    Configuration menu
    Copy the full SHA
    84ba73e View commit details
    Browse the repository at this point in the history
  2. chore: Prepare release 2.0.7

    pawamoy committed Aug 17, 2026
    Configuration menu
    Copy the full SHA
    624974a View commit details
    Browse the repository at this point in the history

Commits on Aug 31, 2026

  1. Configuration menu
    Copy the full SHA
    c0424f2 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    5054240 View commit details
    Browse the repository at this point in the history
  3. chore: Prepare release 2.0.8

    pawamoy committed Aug 31, 2026
    Configuration menu
    Copy the full SHA
    8125b0d View commit details
    Browse the repository at this point in the history

Commits on Sep 22, 2026

  1. fix: Expand relative cross-references against the object the docstrin…

    …g was written on
    
    With inherited members enabled, docstrings of base class members are rendered in the docs of the inheriting class, where the current object is a Griffe alias living under the inheriting class. Leading-dot relative cross-references found in such docstrings were therefore expanded against the consumer's tree instead of the dependency's tree, resolving to wrong targets or failing strict builds.
    
    Anchor the dot-walk on the docstring's parent (the defining object) when it is reachable, falling back to the current object otherwise.
    
    Issue-341: #341
    PR-342: #342
    devtechedge authored Sep 22, 2026
    Configuration menu
    Copy the full SHA
    a9a4ca3 View commit details
    Browse the repository at this point in the history
  2. fix: Improve inventory object types (incorrectly called roles in mkdo…

    …cstrings)
    
    Issue-339: #339
    PR-340: #340
    pawamoy authored Sep 22, 2026
    Configuration menu
    Copy the full SHA
    d754326 View commit details
    Browse the repository at this point in the history
  3. perf: Small performance improvement when getting aliases and formatti…

    …ng/highlighting signatures
    pawamoy committed Sep 22, 2026
    Configuration menu
    Copy the full SHA
    2263163 View commit details
    Browse the repository at this point in the history
  4. chore: Prepare release 2.0.9

    pawamoy committed Sep 22, 2026
    Configuration menu
    Copy the full SHA
    c888dc2 View commit details
    Browse the repository at this point in the history
Loading