Minor cleanups for SDK devsite docs.

Minor cleanups for SDK devsite docs.

Add -W to SHPINXOPTS to make warnings into error.

Add presubmit check that makes sure sphinx is happy
with the content.

Use 2 spaces to indent code.

Add a missing document.

Fix document links in examples.rst.

Use 'out' for build product data to be constent with
chrome and native_client.

Add 'all' target so that 'make' on its own will work
(I'm lazy)

R=binji@chromium.org, eliben@chromium.org

Committed: https://src.chromium.org/viewvc/chrome?view=rev&revision=221806

[eliben, 2013-09-04 21:50:50]

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
File native_client_sdk/src/doc/Makefile (right):

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
native_client_sdk/src/doc/Makefile:8: BUILDDIR      = out
Why out and not _build? _build is standard for Sphinx and it starts with an
underscore so it's unlikely to clash with real subdirs

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
File native_client_sdk/src/doc/devguide/devcycle/debugging.rst (right):

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:1: ..
_devcycle-debugging:
Should say 'devguide-debugging'?

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
File native_client_sdk/src/doc/devguide/distributing.rst (right):

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
native_client_sdk/src/doc/devguide/distributing.rst:296: .. naclcode::
:prettyprint: 0 too?

[Sam Clegg, 2013-09-04 21:54:29]

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
File native_client_sdk/src/doc/Makefile (right):

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
native_client_sdk/src/doc/Makefile:8: BUILDDIR      = out
On 2013/09/04 21:50:51, eliben wrote:
> Why out and not _build? _build is standard for Sphinx and it starts with an
> underscore so it's unlikely to clash with real subdirs

Just because 'out' is the convention for chrome and native_client.

I don't care too much about this.

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
File native_client_sdk/src/doc/devguide/devcycle/debugging.rst (right):

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:1: ..
_devcycle-debugging:
On 2013/09/04 21:50:51, eliben wrote:
> Should say 'devguide-debugging'?

Copied from devguide/devcycle/building.rst.  Which way is better?

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
File native_client_sdk/src/doc/devguide/distributing.rst (right):

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
native_client_sdk/src/doc/devguide/distributing.rst:296: .. naclcode::
On 2013/09/04 21:50:51, eliben wrote:
> :prettyprint: 0 too?

Done.

[Sam Clegg, 2013-09-04 22:12:25]

Might be overkill but I added a presubmit here to
make sure nothing gets submitted that sphinx doesn't
like to look of.

[binji, 2013-09-05 00:52:51]

lgtm, make sure eliben is OK with it too, though

https://codereview.chromium.org/23531031/diff/17001/native_client_sdk/src/doc...
File native_client_sdk/src/doc/Makefile (right):

https://codereview.chromium.org/23531031/diff/17001/native_client_sdk/src/doc...
native_client_sdk/src/doc/Makefile:5: SPHINXOPTS    = -W
quick comment explaining this flag?

https://codereview.chromium.org/23531031/diff/17001/native_client_sdk/src/doc...
File native_client_sdk/src/doc/PRESUBMIT.py (right):

https://codereview.chromium.org/23531031/diff/17001/native_client_sdk/src/doc...
native_client_sdk/src/doc/PRESUBMIT.py:1: # Copyright (c) 2012 The Chromium
Authors. All rights reserved.
2013

https://codereview.chromium.org/23531031/diff/17001/native_client_sdk/src/doc...
native_client_sdk/src/doc/PRESUBMIT.py:7: def _CheckSphinxBuild(input_api,
output_api):
I assume this is only run if a file in the docs directory is changed, correct?

https://codereview.chromium.org/23531031/diff/17001/native_client_sdk/src/doc...
File native_client_sdk/src/doc/README (right):

https://codereview.chromium.org/23531031/diff/17001/native_client_sdk/src/doc...
native_client_sdk/src/doc/README:36: make SPHINXOPTS='-D
devsite_production_mode=0'
While you're here, can you make a 'make' alias for this too?

https://codereview.chromium.org/23531031/diff/17001/native_client_sdk/src/doc...
File native_client_sdk/src/doc/devguide/devcycle/debugging.rst (right):

https://codereview.chromium.org/23531031/diff/17001/native_client_sdk/src/doc...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:1: ..
_devcycle-debugging:
I think I already added this file.

[eliben, 2013-09-05 15:47:20]

lgtm

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
File native_client_sdk/src/doc/Makefile (right):

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
native_client_sdk/src/doc/Makefile:8: BUILDDIR      = out
On 2013/09/04 21:54:30, Sam Clegg wrote:
> On 2013/09/04 21:50:51, eliben wrote:
> > Why out and not _build? _build is standard for Sphinx and it starts with an
> > underscore so it's unlikely to clash with real subdirs
> 
> Just because 'out' is the convention for chrome and native_client.
> 
> I don't care too much about this.
> 

I don't care too much either. I stated the reasons for keeping _build; you
decide ;-)

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
File native_client_sdk/src/doc/devguide/devcycle/debugging.rst (right):

https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
native_client_sdk/src/doc/devguide/devcycle/debugging.rst:1: ..
_devcycle-debugging:
On 2013/09/04 21:54:30, Sam Clegg wrote:
> On 2013/09/04 21:50:51, eliben wrote:
> > Should say 'devguide-debugging'?
> 
> Copied from devguide/devcycle/building.rst.  Which way is better?

Never mind, it seems correct.

[Sam Clegg, 2013-09-06 22:46:27]

On 2013/09/05 15:47:20, eliben wrote:
> lgtm
> 
>
https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
> File native_client_sdk/src/doc/Makefile (right):
> 
>
https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
> native_client_sdk/src/doc/Makefile:8: BUILDDIR      = out
> On 2013/09/04 21:54:30, Sam Clegg wrote:
> > On 2013/09/04 21:50:51, eliben wrote:
> > > Why out and not _build? _build is standard for Sphinx and it starts with
an
> > > underscore so it's unlikely to clash with real subdirs
> > 
> > Just because 'out' is the convention for chrome and native_client.
> > 
> > I don't care too much about this.
> > 
> 
> I don't care too much either. I stated the reasons for keeping _build; you
> decide ;-)

OK.. I reverted that part of the change.
> 
>
https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
> File native_client_sdk/src/doc/devguide/devcycle/debugging.rst (right):
> 
>
https://codereview.chromium.org/23531031/diff/3001/native_client_sdk/src/doc/...
> native_client_sdk/src/doc/devguide/devcycle/debugging.rst:1: ..
> _devcycle-debugging:
> On 2013/09/04 21:54:30, Sam Clegg wrote:
> > On 2013/09/04 21:50:51, eliben wrote:
> > > Should say 'devguide-debugging'?
> > 
> > Copied from devguide/devcycle/building.rst.  Which way is better?
> 
> Never mind, it seems correct.

[Sam Clegg, 2013-09-06 22:51:26]

Committed patchset #6 manually as r221806 (presubmit successful).