Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Failed to build documentation locally

未关闭
#465 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
python

调研方向

Start with CONTRIBUTING.md and requirements-docs.txt, then reproduce the failure by running mkdocs serve in the documentation setup. Check why the mdx_truly_sane_lists extension and mkdocstrings plugin cannot be loaded with the listed packages. Done means the documented local publishing workflow builds without these configuration errors.

由索引模型根据 Issue 内容生成。

描述

I encounter an error when publishing documentation locally using mkdocs according to the CONTRIBUTING.md doc.

After installing the requirements-docs.txt, I run the mkdocs serve command, and there is an error says:

INFO     -  Building documentation...
ERROR    -  Config value: 'markdown_extensions'. Error: Failed loading extension "mdx_truly_sane_lists".
ERROR    -  Config value: 'plugins'. Error: The "mkdocstrings" plugin is not installed
Aborted with 2 Configuration Errors!

Here is my installed packages:

$ pip freeze
astunparse==1.6.3
click==8.1.3
colorama==0.4.6
ghp-import==2.1.0
griffe==0.29.1
importlib-metadata==6.7.0
Jinja2==3.1.2
Markdown==3.3.7
MarkupSafe==2.1.3
mdx-truly-sane-lists==1.3
mergedeep==1.3.4
mkdocs==1.3.1
mkdocs-autorefs==0.4.1
mkdocs-include-markdown-plugin==3.3.0
mkdocs-material==8.2.16
mkdocs-material-extensions==1.1.1
mkdocstrings==0.18.1
mkdocstrings-python==0.6.6
mkdocstrings-python-legacy==0.2.2
packaging==23.1
Pygments==2.15.1
pymdown-extensions==10.0.1
python-dateutil==2.8.2
-e git+https://github.com/theskumar/python-dotenv.git@137bc3dc0b8cf3d417a1e800c4065c526e3fb96a#egg=python_dotenv
pytkdocs==0.16.1
PyYAML==6.0
pyyaml_env_tag==0.1
six==1.16.0
watchdog==3.0.0
zipp==3.15.0

System:

  • macOS Ventura 13.4 on Apple M1 MacBook Air
  • Python 3.8.12
主要语言
Python
星标
8.9k
派生
581
PR 合并指标
30 天内没有已合并 PR

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

theskumar/python-dotenv 的其他 Issue

查看 theskumar/python-dotenv 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。