Skip to content

Step 3 in "how to add documentation" yields errors #13

@LucaTedeschini

Description

@LucaTedeschini

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 with apt 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 serve was still not found (I uninstalled the one installed with apt in the meantime) , so I tried python3 -m mkdocs serve, and it worked fine. I think running the plain mkdocs command causes the shell to launch the system binary mkdocs, while specifying python3 -m mkdocs ensures 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions