Quentin Young
3eb7a2f08b
doc: reorganize
...
* Move all developer related docs into developer/
* Move all figures into their own directory
* Move manpages to own directory
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-30 16:14:24 -05:00
Quentin Young
cb39e63e59
doc: manually merge isis.rst
...
Manually merged:
ee65c55e2a
2018-01-30 16:12:26 -05:00
Quentin Young
e3c1296cb4
doc: add pim.rst
...
Manually merged:
42642babdd
2018-01-30 16:08:10 -05:00
Quentin Young
a5a48dbf20
doc: additional merging
...
Manually merged:
6347ca161f
2018-01-30 15:53:17 -05:00
Quentin Young
d38549c99d
Merge branch 'master' into docs-user
...
Manually merged these doc commits:
3bb7cd7f56ff21655441
2018-01-30 15:05:15 -05:00
Quentin Young
c1a54c054d
doc: manually finish conversion
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-29 16:38:07 -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
50e75a2b82
doc: cleanup kernel.rst
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-29 10:57:13 -05:00
Quentin Young
655cdc3233
doc: fixup routemap.rst
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-29 10:46:35 -05:00
Quentin Young
ec8404d84b
doc: remove some more @stuff{}
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 17:09:25 -05:00
Quentin Young
a8c90e154f
doc: strip trailing whitespace
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 16:15:48 -05:00
Quentin Young
d50b2aa038
doc: use :abbr:
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 16:15:48 -05:00
Quentin Young
dfab2669d3
doc: use :term:, will add glossary later
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 16:15:48 -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
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
a4c5392863
doc: replace random @cite{RFC...} with :rfc:...
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 14:44:58 -05:00
Quentin Young
07a17e6d4e
doc: shotgun cleanup
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 14:43:21 -05:00
Quentin Young
8fa64b2a3f
doc: @smp{foo} -> `foo`
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 13:50:36 -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
a90cfb7f71
doc: fixup eigrpd.rst
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 12:57:34 -05:00
Quentin Young
fce2ac600e
doc: remove @group / @end group
...
Don't need these in RST
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 12:38:08 -05:00
Quentin Young
c2caa2970b
doc: rename main.rst -> zebra.rst
...
This name hasn't made sense for a long time.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-26 12:35:52 -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
f381786082
doc: move routeserver.rst into bgp.rst
...
This is an incomplete stub of a chapter and goes under BGP docs anyway.
Also fix an include statement for RPKI.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-19 17:09:03 -05:00
Quentin Young
44f2550ef3
doc: clean up overview.rst, installation.rst
...
Just reading through the docs and fixing bugs as I go.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-19 17:05:13 -05:00
Quentin Young
dc1046f726
doc: Frr -> FRR
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-19 17:05:13 -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
c3c5a71ff6
doc: fixup bgpd.rst
...
Will probably need more cleanup.
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2018-01-16 13:11:25 -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
8d2098618c
doc: fixup basic.rst
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2017-12-22 16:30:56 -05:00
Quentin Young
2dd0a0ed1d
doc: fixup babeld.rst
...
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2017-12-20 18:22:17 -05:00
Quentin Young
4652e58cef
doc: fixup ipv6.rst
...
Manual cleanup from leftover texi -> rst
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2017-12-20 18:22:12 -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
