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/contributing.md outdated using poetry #948

Open
1 task done
jiangying000 opened this issue May 26, 2024 · 2 comments
Open
1 task done

docs/contributing.md outdated using poetry #948

jiangying000 opened this issue May 26, 2024 · 2 comments

Comments

@jiangying000
Copy link

Privileged issue

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

Issue Content

the doc is outdate because it's still using poetry while should be using pdm

https://github.com/tiangolo/sqlmodel/blob/376603efb2799f5b0565a7a29660601ed629d1fd/docs/contributing.md

@shekhuverma
Copy link

Hello @tiangolo, I also noticed this when making the development environment.
After installing PDM and doing

pdm install -d

It creates a local venv and I'm also able to see the local changes made to sqlmodel.
After activating the environment, when I do

pip list | grep mkdocs

I can see that mkdocs is installed in the newly created venv

mkdocs                          1.6.0
mkdocs-autorefs                 1.0.1
mkdocs-get-deps                 0.2.0
mkdocs-markdownextradata-plugin 0.2.5
mkdocs-material                 9.4.7
mkdocs-material-extensions      1.3.1
mkdocs-redirects                1.2.1
mkdocstrings                    0.23.0
mkdocstrings-python             1.9.1

But when I do

cd scripts
python docs.py

I get the error

ModuleNotFoundError: No module named 'mkdocs'

Can you please point me in the right direction if I'm doing anything wrong?
I noticed this when I was building docs to see the changes.
Thank You!

@smiling-watermelon
Copy link

Also of note, the bash scripts/docs-live.sh command should be replaced with python scripts/docs.py live (or pdm run).

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

3 participants