theskumar / theskumar/python-dotenv

Failed to build documentation locally

Open
#465 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
8.9k
Forks
581
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

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.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.