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

Docs run script error #12426

Closed
1 task done
vahidzhe opened this issue Oct 11, 2024 · 5 comments
Closed
1 task done

Docs run script error #12426

vahidzhe opened this issue Oct 11, 2024 · 5 comments

Comments

@vahidzhe
Copy link

vahidzhe commented Oct 11, 2024

Privileged issue

  • I'm @tiangolo or he asked me directly to create an issue here.

Issue Content

I cloned the project and installed requirements.txt. When I run python ./scripts/docs.py live az, I get the following error.

OS: Windows 10
Python version 3.12.5

image

@vahidzhe
Copy link
Author

vahidzhe commented Oct 14, 2024

@tiangolo Please look at this

@Kludex
Copy link
Member

Kludex commented Oct 14, 2024

No need to ping. It's already marked as issue.

@ptt3199
Copy link
Contributor

ptt3199 commented Jan 30, 2025

Hey @vahidzhe, have you tried these, they solve this problem for me

pip install \
    "mkdocstrings[python]>=0.18" \
    griffe-typingdoc \
    mkdocs-material \
    mkdocs-macros-plugin \
    mkdocs-redirects \
    mdx_include \
    mkdocs-markdownextradata-plugin

And I also comment out this line in file docs/en/mkdocs.yml
markdown_include_variants:

@dalethestirling
Copy link

This error does not occur on HEAD (commit e988050f79b32c9444fba8d014d0c69cd7a4b6c7) when run locally cloned fork on macOS (Sonoma 14.5).

Performed the same steps as @vahidzhe running python ./scripts/docs.py live az

Python: 3.12.4
mkDocs: 1.6.1

@Kludex
Copy link
Member

Kludex commented Mar 19, 2025

It works just fine if I install the requirements.txt, and then run the proposed python ./scripts/docs.py live az.

@Kludex Kludex closed this as not planned Won't fix, can't repro, duplicate, stale Mar 19, 2025
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

4 participants