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.

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

Intersphinx inventory file always sets version to 0.0.0 #439

Open
jayqi opened this issue Jun 3, 2022 · 1 comment
Open

Intersphinx inventory file always sets version to 0.0.0 #439

jayqi opened this issue Jun 3, 2022 · 1 comment
Labels
feature New feature or request

Comments

@jayqi
Copy link

jayqi commented Jun 3, 2022

Currently, the created Intersphinx inventory file always sets the "Version" attribute to 0.0.0. This is because the handler does not pass through the project version to the Inventory object on instantiation, so it ends up using the default value.

self.inventory: Inventory = Inventory(project=self._config["site_name"])

class Inventory(dict):
"""Inventory of collected and rendered objects."""
def __init__(self, items: Optional[List[InventoryItem]] = None, project: str = "project", version: str = "0.0.0"):
"""Initialize the object.
Arguments:
items: A list of items.
project: The project name.
version: The project version.
"""

Expected behavior
The Intersphinx inventory file should reflect the project's version number. (Preferably automatically, but manual would be acceptable if it's the only way to address this.)

Information (please complete the following information):

  • mkdocstrings version: 0.19.0
@jayqi jayqi added the unconfirmed This bug was not reproduced yet label Jun 3, 2022
@pawamoy pawamoy added feature New feature or request and removed unconfirmed This bug was not reproduced yet labels Jun 3, 2022
@pawamoy
Copy link
Member

pawamoy commented Jun 3, 2022

Thanks, marking this as a feature request 🙂

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants