Index: native_client_sdk/src/doc/README |
diff --git a/native_client_sdk/src/doc/README b/native_client_sdk/src/doc/README |
index 7d3a40c5e073a8e907b6d3114dc81fdb381a54ca..5ef8489803effaa435b2367ebe6f5623c29b8766 100644 |
--- a/native_client_sdk/src/doc/README |
+++ b/native_client_sdk/src/doc/README |
@@ -14,7 +14,7 @@ documentation. Some of the files and directories here are special: |
* _static/: Static files, like CSS, for the documentation. This should be seen |
as part of the infrastructure - the real CSS comes from the real doc |
publishing server. |
-* _build/: Build artifacts (not checked into source control). |
+* out/: Build artifacts (not checked into source control). |
* Makefile & README |
How to build |
@@ -23,25 +23,25 @@ How to build |
To build the docs you will needs sphinx installed (and sphinx-build in your |
path), and simply run: |
- make devsite |
+ make |
To rebuild all the pages always, add 'SPHINXOPTS=-a', e.g.: |
- make SPHINXOPTS=-a devsite |
+ make SPHINXOPTS=-a |
To emit local-testing mode, instead of production mode, add: |
SPHINXOPTS='-D devsite_production_mode=0' |
e.g.: |
- make SPHINXOPTS='-D devsite_production_mode=0' devsite |
+ make SPHINXOPTS='-D devsite_production_mode=0' |
Production mode contains devsite-specific templating and non-HTML constructs. |
The builder prints out the value of this setting - make sure it's what you |
expect it to be. For example: |
- $ make devsite |
- sphinx-build -b devsite -d _build/doctrees . _build/devsite |
+ $ make |
+ sphinx-build -b devsite -d out/doctrees . out/devsite |
Running Sphinx v1.2b1 |
loading pickled environment... done |
----> Devsite builder with production mode = 1 |