| Index: native_client_sdk/src/doc/rest-devsite-examples.rst
|
| diff --git a/native_client_sdk/src/doc/rest-devsite-examples.rst b/native_client_sdk/src/doc/rest-devsite-examples.rst
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..e4de8ea881a4e75b913588fa240fdb88c0e13a7c
|
| --- /dev/null
|
| +++ b/native_client_sdk/src/doc/rest-devsite-examples.rst
|
| @@ -0,0 +1,208 @@
|
| +.. _getting_started:
|
| +
|
| +####################################################
|
| +Examples of ReST markup for devsite (Document title)
|
| +####################################################
|
| +
|
| +This is an auto-generated table of contents for this document. ``:local:`` and
|
| +``:backlinks: none`` are required to make the devsite look consistent;
|
| +``:depth:`` level can be controlled.
|
| +
|
| +.. contents::
|
| + :local:
|
| + :backlinks: none
|
| + :depth: 2
|
| +
|
| +Document structure
|
| +==================
|
| +
|
| +A document starts with a Sphinx target which serves as the document name
|
| +throughout the tree. It can serve as a link target in other documents that want
|
| +to link to this one (see the Links section below).
|
| +
|
| +It follows with the document title (which doesn't get generated to the HTML body
|
| +in production mode, but is picked up by the devsite from ``<head><title>``.
|
| +
|
| +Basic markup
|
| +============
|
| +
|
| +In general, follow the rules from http://sphinx-doc.org/rest.html
|
| +
|
| +Some **bold text** and *italic text* and ``fixed-font text``.
|
| +
|
| +For pleasant collaborative editing, please use the accepted coding guidelines:
|
| +wrap at 80 columns, no tabs, etc.
|
| +
|
| +Quotes (``<blockquote>``) are created by indenting the paragraph:
|
| +
|
| + Most good programmers do programming not because they expect to get paid or
|
| + get adulation by the public, but because it is fun to program.
|
| + -- Linus Torvalds
|
| +
|
| +Images
|
| +======
|
| +
|
| +Please use absolute paths (starting with ``/``) for images:
|
| +
|
| +.. image:: /images/NaclBlock.png
|
| +
|
| +Links
|
| +=====
|
| +
|
| +To other documents within the tree
|
| +----------------------------------
|
| +
|
| +Internal links to other documents are created :doc:`like this <overview>`. The
|
| +document name within the angle brackets is relative to the root dir of the
|
| +devsite doc tree and does not have an extension.
|
| +
|
| +Here's a link to a document in a subdirectory: :doc:`the tutorial
|
| +<devguide/tutorial>`. And a link to a subdirectory index page :doc:`devguide index <devguide/index>`.
|
| +
|
| +To sections inside documents
|
| +----------------------------
|
| +
|
| +To internal locations within documents, labels are used. For example, this link
|
| +goes to the label explicitly placed in this document -
|
| +:ref:`link_for_section_heading`. This works across documents as well. Label
|
| +names must be unique in the tree, and can refer to anything (like images).
|
| +
|
| +It's also possible to give such cross-references custom names: :ref:`Same
|
| +Section Heading<link_for_section_heading>`.
|
| +
|
| +To external locations
|
| +---------------------
|
| +
|
| +Plain links can be placed like this: http://google.com and also `like this
|
| +<http://google.com>`_.
|
| +
|
| +Notes and Admonitions
|
| +=====================
|
| +
|
| +The devsite supports special "notes" that are indented and have a background
|
| +color. We'll generate them with the ``Note`` directive, providing the class
|
| +explicitly. The class is one of ``note``, ``caution``, ``warning``,
|
| +``special``.
|
| +
|
| +.. Note::
|
| + :class: note
|
| +
|
| + This is a note.
|
| +
|
| + Foo bar.
|
| +
|
| +Also:
|
| +
|
| +.. Note::
|
| + :class: caution
|
| +
|
| + Caution -- you have been warned.
|
| +
|
| +Source code
|
| +===========
|
| +
|
| +Here's source code that will be pretty-printed on the devsite. Outside
|
| +production mode, it's just a plain ``<pre>`` that presents pre-formatted code
|
| +without coloring:
|
| +
|
| +.. naclcode::
|
| +
|
| + #include <iostream>
|
| +
|
| + int main() {
|
| + std::cout << "Hello world\n";
|
| + return 0;
|
| + }
|
| +
|
| +For some code (like shell samples), we want to disable pretty-printing:
|
| +
|
| +.. naclcode::
|
| + :prettyprint: 0
|
| +
|
| + $ ls | wc
|
| + $ echo "hello world"
|
| +
|
| +By default ``:prettyprint:`` is ``1``.
|
| +
|
| +.. _link_for_section_heading:
|
| +
|
| +Section heading
|
| +===============
|
| +
|
| +Here's a demonstration of heading nesting levels. This is a top-level section in
|
| +the document. The document title is the first header and it's delimited by hash
|
| +signes (``#``) from above and below.
|
| +
|
| +Subsection heading
|
| +------------------
|
| +
|
| +Subsection.
|
| +
|
| +Sub-subsection heading
|
| +^^^^^^^^^^^^^^^^^^^^^^
|
| +
|
| +That's pretty deep...
|
| +
|
| +Sub-sub-subsection heading
|
| +""""""""""""""""""""""""""
|
| +
|
| +It's probably not the best idea to go this far (renders to ``<h5>``).
|
| +
|
| +Lists
|
| +=====
|
| +
|
| +Auto-numbered ordered lists:
|
| +
|
| +#. One
|
| +#. Two
|
| +#. Three
|
| +
|
| +Manually numbered ordered lists:
|
| +
|
| +1. One
|
| +2. Two
|
| +3. Three
|
| +
|
| +Unordered (bullet) lists:
|
| +
|
| +* One
|
| +* Two
|
| +* Three
|
| +
|
| +Lists can be nested and mixed too:
|
| +
|
| +* Toplevel
|
| +
|
| + 1. One
|
| + 2. Two
|
| +
|
| +* Back to top level
|
| +
|
| +Tables
|
| +======
|
| +
|
| +The full scoop on tables is http://sphinx-doc.org/rest.html#tables and the
|
| +Docutils pages linked from it.
|
| +
|
| +"Simple tables" require less markup but are limited:
|
| +
|
| +===== ===== =======
|
| +A B A and B
|
| +===== ===== =======
|
| +False False False
|
| +True False False
|
| +False True False
|
| +True True True
|
| +===== ===== =======
|
| +
|
| +"Grid tables" are versatile but require more markup:
|
| +
|
| ++------------------------+------------+----------+----------+
|
| +| Header row, column 1 | Header 2 | Header 3 | Header 4 |
|
| +| (header rows optional) | | | |
|
| ++========================+============+==========+==========+
|
| +| body row 1, column 1 | column 2 | column 3 | column 4 |
|
| ++------------------------+------------+----------+----------+
|
| +| body row 2 | ... | ... | |
|
| ++------------------------+------------+----------+----------+
|
| +
|
|
|
Chromium Code Reviews
Issue 23835002:
[NaCl docs] Initial commit of the new docs infrastructure into Chromium. (Closed)
Base URL: svn://svn.chromium.org/chrome/trunk/src