MkDocs扩展,根据mkdocs.yml文件列出所有依赖项
项目描述
mkdocs-get-deps
MkDocs的一个额外命令,从mkdocs.yml中的plugins
推断所需的PyPI包。
安装 | 也可以通过MkDocs本身进行 |
pip install mkdocs-get-deps
|
pip install mkdocs
|
此命令猜测MkDocs站点构建所需的Python依赖项。它简单地打印出需要安装的PyPI包。在终端中,可以像下面最后一个例子那样直接与pip install
命令结合
用法 | 也可以通过MkDocs本身进行 |
# Print dependencies of the current project
mkdocs-get-deps
# Save them into a file
mkdocs-get-deps > requirements.txt
# Install dependencies on the fly
pip install $(mkdocs-get-deps)
|
mkdocs get-deps
mkdocs get-deps > requirements.txt
pip install -r requirements.txt
pip install $(mkdocs get-deps)
|
这个想法是在运行这个命令后,可以直接跟随着运行mkdocs build
,并且它几乎总是“直接工作”,无需考虑安装哪些依赖。
它的工作方式是扫描mkdocs.yml
中的themes:
、plugins:
、markdown_extensions:
项,并根据大量已知项目(目录,见下文)进行反向查找。
当然,您被鼓励使用“虚拟环境”来执行此命令。注意,对于需要稳定性的环境(例如CI),直接以这种方式安装依赖并不是一个非常可靠的方法,因为它阻止了依赖项的锁定。
该命令允许覆盖使用的配置文件(而不是当前目录中的mkdocs.yml
)以及使用的项目目录(而不是从默认位置下载)。请参阅mkdocs get-deps --help
。
MkDocs的官方插件目录
请查看https://github.com/mkdocs/catalog,并将所有您的通用插件、主题和扩展添加到那里,这样就可以通过mkdocs get-deps
来查找。
项目详情
关闭
mkdocs_get_deps-0.2.0.tar.gz的散列
算法 | 散列摘要 | |
---|---|---|
SHA256 | 162b3d129c7fad9b19abfdcb9c1458a651628e4b1dea628ac68790fb3061c60c |
|
MD5 | 4144c380f8bea5be5e5da35e3d82984b |
|
BLAKE2b-256 | 98f5ed29cd50067784976f25ed0ed6fcd3c2ce9eb90650aa3b2796ddf7b6870b |
关闭
mkdocs_get_deps-0.2.0-py3-none-any.whl的散列
算法 | 散列摘要 | |
---|---|---|
SHA256 | 2bf11d0b133e77a0dd036abeeb06dec8775e46efa526dc70667d8863eefc6134 |
|
MD5 | 1c190eaf5967d4e29451a7259bea1141 |
|
BLAKE2b-256 | 9fd4029f984e8d3f3b6b726bd33cafc473b75e9e44c0f7e80a5b29abc466bdea |