aboutsummaryrefslogtreecommitdiffstats
path: root/docs/topics/contributing.md
diff options
context:
space:
mode:
authorDougal Matthews2014-10-22 21:36:11 +0100
committerDougal Matthews2014-11-25 12:42:39 +0000
commit84d9c4b46eacda54b31a3779c623554758f4dccc (patch)
treeb32c48210dda963d939f66c47df11edd8cf78a37 /docs/topics/contributing.md
parent04abe9830c1b6c0670a49129529e8e8d9e411f2c (diff)
downloaddjango-rest-framework-84d9c4b46eacda54b31a3779c623554758f4dccc.tar.bz2
Change site_dir to html to match mkdocs.py
Diffstat (limited to 'docs/topics/contributing.md')
-rw-r--r--docs/topics/contributing.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/topics/contributing.md b/docs/topics/contributing.md
index 52f6e287..5809af65 100644
--- a/docs/topics/contributing.md
+++ b/docs/topics/contributing.md
@@ -135,15 +135,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