From 663993621224ed58d01f9162dab78903796e7315 Mon Sep 17 00:00:00 2001 From: Nicolas MASSART Date: Thu, 23 May 2019 01:21:31 +0200 Subject: [PATCH] update doc for python version (#1469) --- MKDOCS-MARKDOWN-GUIDE.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/MKDOCS-MARKDOWN-GUIDE.md b/MKDOCS-MARKDOWN-GUIDE.md index db4c95509e..ebe36be20f 100644 --- a/MKDOCS-MARKDOWN-GUIDE.md +++ b/MKDOCS-MARKDOWN-GUIDE.md @@ -55,7 +55,8 @@ to ensure the Markdown is correctly understood and displayed. To preview Pantheon documentation locally: -- [Install Python](https://www.mkdocs.org/#installing-python) +- [Install Python 3.x](https://www.mkdocs.org/#installing-python) (see [readthedocs.yml](readthedocs.yml) file for +the exact version) - [Install PIP](https://www.mkdocs.org/#installing-pip) - Install all the required dependencies : ```bash @@ -70,7 +71,14 @@ looks like `[I 190206 18:48:47 server:298] Serving on http://127.0.0.1:8000`, here connect to [http://127.0.0.1:8000] You can let this doc server run while you work on the doc, it updates the local website -automatically when you save changes in your Markdown files. +automatically when you save changes in your Markdown files. + +>**Important** +> +> Run `python --version` to make sure you are using version indicated in [readthedocs.yml](readthedocs.yml) file. +> +> If you are updating from a previous Python version you will also have to run pip install again and +check your path. ## Formatting Markdown For Doc Site