Skip to content

Start with pipenv


Pipenv is a tool that aims to bring the best of all packaging worlds (bundler, composer, npm, cargo, yarn, etc.) to the Python world.

Install all packages

pipenv sync --dev  # Installs all packages specified in Pipfile.lock.

Run MkDocs

pipenv shell  # Spawns a shell within the virtualenv.
mkdocs serve

Or, run mkdocs with pipenv run

pipenv run mkdocs serve

pipenv run

pipenv task are also defined by Pipfile

pipenv run version    # mkdocs --version
pipenv run help       # mkdocs --help
pipenv run inv serve  # inv serve
pipenv run serve      # mkdocs serve
pipenv run build      # mkdocs build
pipenv run deploy     # mkdocs gh-deploy