Skip to content

Documentation cross-linking uses old versions #300

Closed

Description

@llucax

What happened?

The generated docs are missing some cross-linking targets because the cross-referencing inventories are either missing or using older versions where the cross-referenced symbols didn't exist.

For example:

- https://frequenz-floss.github.io/frequenz-client-dispatch-python/v0.6/objects.inv

TargetComponents comes from frequenz-client-dispatch but points to v0.6, where it doesn't exist yet (the current minimum dependency version is v0.11.x.

Image

What did you expect instead?

Cross-linking working correctly (mkdocstrings inventory versions in mkdocs.yml matching minimum dependency versions in pyproject.toml, and all dependencies inventories being present).

Affected version(s)

No response

Affected part(s)

Documentation (part:docs)

Extra information

No response

Activity

  1. added theissue type on Sep 17, 2026
  2. added
    priority:❓We need to figure out how soon this should be addressed
    on Sep 17, 2026
  3. added
    type:bugSomething isn't working
    priority:lowThis should be addressed only if there is nothing else on the table
    part:docsAffects the documentation
    and removed
    priority:❓We need to figure out how soon this should be addressed
    on Sep 17, 2026
  4. added a commit that references this issue on Sep 17, 2026
    7961389
  5. added a commit that references this issue on Sep 17, 2026
    e1169fb
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    part:docsAffects the documentationpriority:lowThis should be addressed only if there is nothing else on the tabletype:bugSomething isn't working

    Type

    Fields

    Priority

    Low

    Effort

    Low

    Affected Version

    None yet

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions