uv
7a18e442 - Fix CLI reference with code block (#12807)

Commit
316 days ago
Fix CLI reference with code block (#12807) Due to https://github.com/clap-rs/clap/issues/5900, clap folds docstring code blocks in a way that breaks the rendering of the `uv publish --index` option to html. As a workaround, `verbatim_doc_comment` prevents this. Release: ![image](https://github.com/user-attachments/assets/66d9af51-ac23-47f6-a859-7b20a4f1f4a2) PR: ![image](https://github.com/user-attachments/assets/6a32a5a6-1dd8-49ff-a853-9df02f0141ad) Release: ``` --index <INDEX> The name of an index in the configuration to use for publishing. The index must have a `publish-url` setting, for example: ```toml [[tool.uv.index]] name = "pypi" url = "https://pypi.org/simple" publish-url = "https://upload.pypi.org/legacy/" ``` The index `url` will be used to check for existing files to skip duplicate uploads. With these settings, the following two calls are equivalent: ``` uv publish --index pypi uv publish --publish-url https://upload.pypi.org/legacy/ --check-url https://pypi.org/simple ``` [env: UV_PUBLISH_INDEX=] ``` PR: ``` --index <INDEX> The name of an index in the configuration to use for publishing. The index must have a `publish-url` setting, for example: ```toml [[tool.uv.index]] name = "pypi" url = "https://pypi.org/simple" publish-url = "https://upload.pypi.org/legacy/" ``` The index `url` will be used to check for existing files to skip duplicate uploads. With these settings, the following two calls are equivalent: ```shell uv publish --index pypi uv publish --publish-url https://upload.pypi.org/legacy/ --check-url https://pypi.org/simple ``` [env: UV_PUBLISH_INDEX=] ``` Fixes #12652
Author
Parents
Loading