Commit Graph

58 Commits

Author SHA1 Message Date
Quentin Young
c936589468
doc: cleanup daemon option flags
Short and long form options can be written on the same line, Sphinx
understands how to cross-reference using either one of them. Also
replace some - with _ where appropriate.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-09 17:30:47 -04:00
Quentin Young
0efdf0fe50
doc: clean up cross references
Format reference directives and roles to match best practices.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-01 16:33:14 -05:00
Quentin Young
d1a242fdbf
doc: cleanup multiple
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-29 12:16:20 -05:00
Quentin Young
29adcd5008
doc: fix cli documentation formatting
* Use new 'clicmd' directive / role
* Convert old style range syntax to new style

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 16:15:43 -05:00
Quentin Young
dc5564c76f
doc: cleanup installation instructions
Use program and option directives for CLI options

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 13:29:16 -05:00
Quentin Young
be46d28847
doc: use RST variable substitutions
In conf.py, extract & construct values for inline variables throughout
the docs. In the docs, use these inline variables in RST syntax.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-19 17:05:08 -05:00
Quentin Young
8d2098618c
doc: fixup basic.rst
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2017-12-22 16:30:56 -05:00
Quentin Young
42fc5d2669
doc: start translating user manual to rst
Automatically translated all Texinfo files to RST using a script found
on the GCC mailing list[0]. Some formatting manually corrected.

Also created index.rst for building as well as boilerplate Sphinx
conf.py and Makefile.

[0] https://gcc.gnu.org/ml/gcc-patches/2015-11/msg01095.html

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2017-12-18 16:29:24 -05:00