跳转到主要内容

MkDocs扩展,根据mkdocs.yml文件列出所有依赖项

项目描述

mkdocs-get-deps

MkDocs的一个额外命令,从mkdocs.yml中的plugins推断所需的PyPI包。

PyPI GitHub GitHub Workflow Status

安装也可以通过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 (10.2 kB 查看散列)

上传时间

构建分布

mkdocs_get_deps-0.2.0-py3-none-any.whl (9.5 kB 查看散列)

上传时间 Python 3

支持者

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面