Document the Debian package in the install docs - #288
Open
IgorKasianenko wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Debian accepted
mistral-commoninto the archive aspython3-mistral-common, so it can be installed withaptrather than into a virtual environment. #287 asks for that to be documented.Change
Adds a
Debiansection todocs/usage/install.md, betweenPipandFrom source. Docs only, no code.Claims in the section, and where they come from
python3-mistral-common, architectureall, source packagepython-mistral-common.Dependsarepython3-jsonschema,python3-numpy,python3-pil,python3-pydantic,python3-pydantic-extra-types,python3-requests,python3-tiktokenandpython3-typing-extensions. That is exactly thedependencieslist inpyproject.toml. None ofopencv-python-headless,soundfile,soxr,sentencepiece,llguidance,huggingface-huborfastapiis pulled in, so none of the extras are covered.No version number and no suite name is written into the docs, because both move. The section links to the package page instead.
One thing to be aware of
Version 1.11.7-1 is marked for autoremoval from testing on 5 September 2026, caused by release-critical bugs in transitive dependencies (fastapi, httpcore, jupyter-notebook, node-playwright, node-yarnpkg, towncrier). That affects testing only, not unstable, and the section names no suite, so the text stays accurate either way.
Testing
Markdown only. The pre-commit hooks here (actionlint, ruff-check, ruff-format, uv-lock) do not cover markdown.
mkdocs.ymldoes not enable theadmonitionextension, so the section uses plain headings and a fenced block, matching the rest of the file.Closes #287.
Should the README's "How to use it ?" section carry the same line, or is the docs page enough?