diff options
| author | Dougal Matthews | 2014-10-22 21:36:11 +0100 | 
|---|---|---|
| committer | Dougal Matthews | 2014-11-25 12:42:39 +0000 | 
| commit | 84d9c4b46eacda54b31a3779c623554758f4dccc (patch) | |
| tree | b32c48210dda963d939f66c47df11edd8cf78a37 /CONTRIBUTING.md | |
| parent | 04abe9830c1b6c0670a49129529e8e8d9e411f2c (diff) | |
| download | django-rest-framework-84d9c4b46eacda54b31a3779c623554758f4dccc.tar.bz2 | |
Change site_dir to html to match mkdocs.py
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..ff82c954 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, simply 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 | 
