summaryrefslogtreecommitdiff
path: root/doc/manpages/conf.py
AgeCommit message (Collapse)Author
2024-07-23build: fix a few python string escape warningsDavid Lamparter
When using a regex (or anything that uses `\?` escapes) in python, raw strings (`r"content"`) should be used so python doesn't consume the escapes itself. Otherwise we get either broken behavior and/or `SyntaxWarning: invalid escape sequence '\['` Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2022-10-27doc: Remove `language = none` as that sphinx no longer needs this lineDonald Sharp
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2020-10-07*: reformat python fileswhitespace
We are now using black. Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-03-10docs: fix a warning while building manpagesRuben Kerkhof
$ make doc SPHINX doc/manpages/_build/.doctrees/environment.pickle WARNING: html_static_path entry '_static' does not exist Signed-off-by: Ruben Kerkhof <ruben@rubenkerkhof.com>
2020-01-15doc: rename man pages to frr-*David Lamparter
The vrrpd one conflicts with the standalone vrrpd package; also we're installing daemons to /usr/lib/frr on some systems so they're not on PATH. Signed-off-by: David Lamparter <equinox@diac24.net>
2019-05-17doc: add vrrpd(8)Quentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2019-03-26doc: exclude bfd-options.rst from toctreeQuentin Young
This is an include file, needs to be explicitly excluded to suppress Sphinx warnings. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-09-05doc: add documentation for fabricdChristian Franke
Signed-off-by: Christian Franke <chris@opensourcerouting.org>
2018-08-08bfdd: add documentationRafael Zalamena
Add BFD daemon documentation: * commands; * man page; * manual / description; Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2018-07-29doc: Add some documentation for staticdDonald Sharp
Remove the ip route specific sections from zebra documenation and create a specific one for the new staticd. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-04-30doc: Add some documentation for the sharp daemonDonald Sharp
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-04-12Merge pull request #2039 from qlyoung/docuserRafael Zalamena
doc: more cleanup, config syntax highlighting
2018-04-10doc: gracefully handle missing config.statusQuentin Young
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>
2018-04-06doc: Add documentation for PBRDDonald Sharp
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2018-03-07doc: change html theme to 'default'Quentin Young
Looks like older versions of Sphinx switched around naming for the default themes. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-07doc: fix make setupQuentin Young
Iron out all of the glitches with recursive Automake, 3rd-party autogenerated Sphinx makefiles, building and installing 3 different document formats under different targets, and handling clean. * Implement all Automake-required targets for 3rd-party Makefiles * Setup subdirectories for 3rd-party Makefiles * Override implicit Automake document targets * Clean up explicit targets for developer docs * Move Sphinx-generated Makefile to an include file * Update targets for debian packaging Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-03-01Merge branch 'master' into docuserQuentin Young
* New manpage: mtracebis.rst * Makefile.am includes mtracebis.rst * configure.ac lines removed * Debian packaging files updated * Fixed up manpage |seealso-programs| in the process * Centos7 build package list updated to include systemd-devel * New paragraph on netns vrf support in zebra manpage Conflicts: configure.ac debianpkg/backports/ubuntu14.04/debian/frr.install debianpkg/frr.install doc/Makefile.am doc/developer/Building_FRR_on_CentOS7.rst doc/zebra.8.in Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-07doc: use python 2.6 format stringsQuentin Young
Centos 6 only has python 2.6 which requires numerical identifiers for format strings Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-02-07doc: fix toctree warning in manpagesQuentin Young
Forgot to add a couple includes to the exclude list. Also move defines.txt to defines.rst since I know how to properly ignore things now. Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-31doc: overhaul manpagesQuentin Young
* Remove groff manpages * Rewrite manpages in RST * Clean up and standardize manpage content Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>