-
Notifications
You must be signed in to change notification settings - Fork 0
Step 3 in "how to add documentation" yields errors #13
Copy link
Copy link
Open
Description
I followed the guide step by step blindly for the first time, and mkdocs serve was giving me some errors:
mkdocs not found. To fix this, I installed it withapt install mkdocs. This worked, but a new error appeared (which is the following).
Then, I read the documentation again and found something strange:
- It asks the user to create a
venv, but then it installs the requirements before activating it. I think the correct procedure would be to activate the environment first and then install the requirements. - The command
mkdocs servewas still not found (I uninstalled the one installed withaptin the meantime) , so I triedpython3 -m mkdocs serve, and it worked fine. I think running the plainmkdocscommand causes the shell to launch the system binarymkdocs, while specifyingpython3 -m mkdocsensures that the correct program is executed.
Tell me if I did something wrong / my reasoning is wrong.
tl;dr my suggestion is to switch the env activation line with the requirements installation, and change the command mkdocs serve with python3 -m mkdocs serve
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels