Commit Graph

11 Commits

Author SHA1 Message Date
Quentin Young
cb3d8153a3
doc: add more CLI documentation
* Document modes & nodes
* Document walkup behavior
* Document struct cmd_node
* Add graph of node relationships
* Reorder sections to make more logical sense
* Rewrap sections to 80 lines
* Fix code block indent
* Specify language for code blocks in order to get syntax highlighting

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-04-02 15:04:04 -04:00
Quentin Young
4386f12983
doc: tweak html body width
The default theme has a css rule that limits the body element width to
800px, which results in sizeable chunk of empty space to the right of
the docs. Add a small css override to remove this limit (like the Python
docs do).

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-23 13:20:43 -04:00
Quentin Young
37ba370b9e
doc: change html theme to 'default'
Looks like older versions of Sphinx switched around naming for the default
themes.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-07 17:17:36 -05:00
Quentin Young
b59555c6bf
doc: change info file name from FRR -> frr
conventions yo

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-22 12:27:12 -05:00
Quentin Young
2f8c365e02
doc: change html theme, add svg logo
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-08 11:53:49 -05:00
Quentin Young
6c74945622
doc: use python 2.6 format strings
Centos 6 only has python 2.6 which requires numerical identifiers for
format strings

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-07 19:22:52 -05:00
Quentin Young
5a32c42459
doc: add logos
Branding!

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-02 16:27:00 -05:00
Quentin Young
9de103f0c9
doc: document documentation
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-02 15:19:04 -05:00
Quentin Young
7bd01bd49b
doc: copy conf.py for developer's docs
Info extracted will probably prove useful here as well.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-31 17:27:06 -05:00
Quentin Young
b22ba015ef
doc: more organizing & updating
* Add chapter on BGPD
* Add diagram for git workflow
* Convert next-hop tracking documents to ReST
* Update & organize workflow document
* Move ldpd docs back up to the parent directory

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2017-12-08 18:30:14 -05:00
Quentin Young
d1890d041e
doc: begin developer's manual
* Move doc/code/ -> doc/developer/
* Move disparate code documentation to doc/developer/
* Convert Markdown docs to reStructuredText
* Organize docs into Sphinx tree
* Move build docs -> doc/developer/
* Change build doc titles to fit under Building subsection of manual

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2017-12-08 14:08:44 -05:00