From 2a82bd7ee36fe2d9f478e73ddc6dc591e4625605 Mon Sep 17 00:00:00 2001 From: Eric Jolibois Date: Mon, 30 Nov 2020 19:02:36 +0100 Subject: [PATCH] chore: fix contributing steps (#2144) Following #2030, the requirements to build the documentation are not installed with the rest making `make docs` crash when following the contributing steps. As `make install` is only used for this purpose (easy onboarding), let's just add again the installation of the doc requirements with it --- Makefile | 2 +- docs/contributing.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/Makefile b/Makefile index cc5d66b..2a5bacb 100644 --- a/Makefile +++ b/Makefile @@ -25,7 +25,7 @@ install-benchmarks: install-pydantic pip install -U -r benchmarks/requirements.txt .PHONY: install -install: install-testing install-linting +install: install-testing install-linting install-docs @echo 'installed development requirements' .PHONY: build-trace diff --git a/docs/contributing.md b/docs/contributing.md index c154c28..2ddfd11 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -33,7 +33,7 @@ To make contributing as easy and fast as possible, you'll want to run tests and *pydantic* has few dependencies, doesn't require compiling and tests don't need access to databases, etc. Because of this, setting up and running the tests should be very simple. -You'll need to have **python 3.6**, **3.7**, or **3.8**, **virtualenv**, **git**, and **make** installed. +You'll need to have **python 3.6**, **3.7**, **3.8**, or **3.9**, **virtualenv**, **git**, and **make** installed. ```bash # 1. clone your fork and cd into the repo directory @@ -45,7 +45,7 @@ virtualenv -p `which python3.7` env source env/bin/activate # (or however you prefer to setup a python environment, 3.6 will work too) -# 3. Install pydantic, dependencies and test dependencies +# 3. Install pydantic, dependencies, test dependencies and doc dependencies make install # 4. Checkout a new branch and make your changes