Commit Graph

13 Commits

Author SHA1 Message Date
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
9e146a818b
doc: fix more broken refs, restore routeserver.rst
At some point the routeserver docs got lost, converted those from texi
and put them back. Also fixed some broken cli xrefs.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-01 17:38:05 -05:00
Quentin Young
013f9762db
doc: fixup some build warnings
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-01 16:10:11 -05:00
Quentin Young
2731b07dba
doc: add clicmd role for frr cli
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 15:51:59 -05:00
Quentin Young
fd8100976e
doc: set 'release' and 'version' again
accidentally removed in older commit

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-19 17:24:48 -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
964b36623b
doc: make conf.py know about variable substitutions
The old Texi docs had some Makefile-style variable substitutions they
used to pull in information like release date, configured install path,
etc. Sphinx has this ability as well, we start making use of it here.

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-12 16:00:24 -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