diff options
| author | Tom Christie | 2014-11-25 16:27:00 +0000 |
|---|---|---|
| committer | Tom Christie | 2014-11-25 16:27:00 +0000 |
| commit | f13c0ebe69f92ecad7e84257b3baf2ccafe69b3e (patch) | |
| tree | 5de4f2bcbd973513197c809b301f05f21b9db325 /CONTRIBUTING.md | |
| parent | 8c91e7b742067b6d4e4ed6d476bfe2cf5839ac8b (diff) | |
| parent | b733f85ff1e3f70e9f5dee6f52bebe861bc0f411 (diff) | |
| download | django-rest-framework-f13c0ebe69f92ecad7e84257b3baf2ccafe69b3e.tar.bz2 | |
Merge master
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1b199534..69802995 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -101,15 +101,15 @@ There are many great markdown editors that make working with the documentation r ## Building the documentation -To build the documentation, simply run the `mkdocs.py` script. +To build the documentation, install MkDocs with `pip install mkdocs` and then run the following command. - ./mkdocs.py + mkdocs build This will build the html output into the `html` directory. -You can build the documentation and open a preview in a browser window by using the `-p` flag. +You can build the documentation and open a preview in a browser window by using the `serve` command. - ./mkdocs.py -p + mkdocs serve ## Language style |
