Skip to content
This repository has been archived by the owner on Sep 26, 2019. It is now read-only.

Commit

Permalink
update doc for python version (#1469)
Browse files Browse the repository at this point in the history
  • Loading branch information
NicolasMassart authored May 22, 2019
1 parent a12a6ab commit 6639936
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions MKDOCS-MARKDOWN-GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

Expand Down

0 comments on commit 6639936

Please sign in to comment.