Commit 84d9c4b4 by Dougal Matthews

Change site_dir to html to match mkdocs.py

parent 04abe983
...@@ -101,15 +101,15 @@ There are many great markdown editors that make working with the documentation r ...@@ -101,15 +101,15 @@ There are many great markdown editors that make working with the documentation r
## Building the documentation ## 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. 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 ## Language style
......
...@@ -135,15 +135,15 @@ There are many great Markdown editors that make working with the documentation r ...@@ -135,15 +135,15 @@ There are many great Markdown editors that make working with the documentation r
## Building the documentation ## 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. 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 ## Language style
......
...@@ -51,6 +51,7 @@ pages: ...@@ -51,6 +51,7 @@ pages:
- ['topics/release-notes.md', ] - ['topics/release-notes.md', ]
- ['topics/credits.md', ] - ['topics/credits.md', ]
site_dir: html
theme_dir: docs/theme theme_dir: docs/theme
copyright: Copyright &copy; 2014, <a href="https://twitter.com/_tomchristie">Tom Christie</a>. copyright: Copyright &copy; 2014, <a href="https://twitter.com/_tomchristie">Tom Christie</a>.
google_analytics: ['UA-18852272-2', 'django-rest-framework.org'] google_analytics: ['UA-18852272-2', 'django-rest-framework.org']
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment