Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Failed to build documentation locally #465

Open
Georgehu716 opened this issue Jun 22, 2023 · 1 comment
Open

Failed to build documentation locally #465

Georgehu716 opened this issue Jun 22, 2023 · 1 comment

Comments

@Georgehu716
Copy link

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
@theskumar
Copy link
Owner

I'll take a look thanks for raising the issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants