Failed to build documentation locally

Aperta
#465 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
3/5
Tempo stimato
1-2 giorni
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
python
Ambito
build-system, documentation

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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
Lingua principale
Python
Stelle
8.9k
Fork
581
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di theskumar/python-dotenv

Tutte le issue di theskumar/python-dotenv

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.