7 Commits

Author SHA1 Message Date
YAMAMOTO Takashi
0a8e581628 doc: fix some sphinx warnings and errors
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-13 10:01:54 +09:00
YAMAMOTO Takashi
beb9867d7a doc: fix a typo
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-08-13 10:01:51 +09:00
YAMAMOTO Takashi
e1c7f737f5 try to sync documentation with the reality
Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-02-25 20:08:44 +09:00
YAMAMOTO Takashi
0a6d7c5619 mechanical documentation update after option name changes
s/_/-/ in option names.

note: some parts of them (eg. eventdumper, nova, ...) looks outdated
but i didn't try to update them at least in this commit.

Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-02-25 20:08:22 +09:00
YAMAMOTO Takashi
9ba977fa41 update a sample and documentation
try to sync the documentation with the reality at least about
gflags/cfg changes.

Signed-off-by: YAMAMOTO Takashi <yamamoto@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-02-14 12:34:08 +09:00
Isaku Yamahata
48bd30f8f1 doc: eliminate sphinx warnings
This patch eliminates the following sphinx warnings.

> ryu/doc/source/parameters.rst:47: ERROR: Unexpected indentation.
> ryu/doc/source/step_by_step.rst:1: WARNING: malformed hyperlink target.
> ryu/doc/source/step_by_step.rst:164: ERROR: Inconsistent literal block quoting.
> ryu/doc/source/step_by_step.rst:229: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:278: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:320: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:329: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:333: WARNING: Bullet list ends without a blank line; unexpected unindent.
> ryu/doc/source/step_by_step.rst:357: WARNING: Bullet list ends without a blank line; unexpected unindent.
> checking consistency... ryudoc/source/parameters.rst:: WARNING: document isn't included in any toctree

Signed-off-by: Isaku Yamahata <yamahata@valinux.co.jp>
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2013-02-12 20:21:26 +09:00
FUJITA Tomonori
9b3246a630 doc: rename getting_started.rst -> parameters.rst
The 'getting_started' content overlaps with README. It also includes
more advanced information than 'getting_started'. This is preparation
for making README 'getting_started'.

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
2012-09-17 13:15:44 +09:00