summaryrefslogtreecommitdiffstats
path: root/doc/user/conf.py (follow)
Commit message (Collapse)AuthorAgeFilesLines
* doc: support VPATH buildsQuentin Young2018-05-021-1/+9
| | | | | | | | | | | Documentation was not fully using Automake / Autoconf and therefore needs modifications to support black magic VPATH builds. * Convert Makefile's to Autoconf-controlled Makefile.in's * Tweak loading of pygments lexer to handle runtime paths * Update .gitignore's as necessary Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
* doc: gracefully handle missing config.statusQuentin Young2018-04-101-19/+25
| | | | | | | | | The docs extract various configuration values from config.status and substitute them into placeholders throughout the docs. Add the ability to build the docs with some reasonable defaults set instead of failing when config.status doesn't exist. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
* doc: load lexer differentlyQuentin Young2018-04-101-3/+10
| | | | | | | | | Pygments 2.2+ has `load_lexer_from_file`, but it looks like some of our build platforms are on an older version. Also gotta include the new file in dist tarball. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
* doc: add frr.conf syntax highlightingQuentin Young2018-04-091-0/+5
| | | | | | | | | | | | Vincent Bernat has written a small Pygments lexer for IOS / Quagga config files that works just as well on FRR stuff. Pulled that into our docs with his blessing. Also changed the background color on our code blocks away from that kinda ugly green to gray, which looks way better with the syntax highlighting changes that are about to happen in the next commit. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
* doc: tweak html body widthQuentin Young2018-03-231-1/+3
| | | | | | | | | 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>
* doc: change html theme to 'default'Quentin Young2018-03-071-1/+1
| | | | | | | Looks like older versions of Sphinx switched around naming for the default themes. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
* doc: change info file name from FRR -> frrQuentin Young2018-02-221-1/+1
| | | | | | conventions yo Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
* doc: change html theme, add svg logoQuentin Young2018-02-081-4/+6
| | | | Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
* doc: use python 2.6 format stringsQuentin Young2018-02-081-2/+2
| | | | | | | Centos 6 only has python 2.6 which requires numerical identifiers for format strings Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
* doc: add logosQuentin Young2018-02-021-3/+3
| | | | | | Branding! Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
* doc: fix more broken refs, restore routeserver.rstQuentin Young2018-02-011-1/+1
| | | | | | | 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>
* doc: fixup some build warningsQuentin Young2018-02-011-1/+1
| | | | Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
* doc: add clicmd role for frr cliQuentin Young2018-01-261-0/+6
| | | | Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
* doc: set 'release' and 'version' againQuentin Young2018-01-191-1/+5
| | | | | | accidentally removed in older commit Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
* doc: use RST variable substitutionsQuentin Young2018-01-191-12/+30
| | | | | | | 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>
* doc: make conf.py know about variable substitutionsQuentin Young2018-01-121-2/+20
| | | | | | | | 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>
* doc: start translating user manual to rstQuentin Young2017-12-181-0/+293
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>