From: Quentin Young Date: Wed, 7 Feb 2018 18:36:03 +0000 (-0500) Subject: doc: fix toctree warning in manpages X-Git-Tag: frr-5.0-dev~165^2~36 X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=12b7724ff82caf19beb9c20e570a43af8d343674;p=mirror%2Ffrr.git doc: fix toctree warning in manpages 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 --- diff --git a/doc/manpages/bgpd.rst b/doc/manpages/bgpd.rst index 73ca6b2351..94213db4d7 100644 --- a/doc/manpages/bgpd.rst +++ b/doc/manpages/bgpd.rst @@ -2,7 +2,7 @@ BGPD **** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: bgpd SYNOPSIS diff --git a/doc/manpages/conf.py b/doc/manpages/conf.py index 6aa8588039..403e86e55e 100644 --- a/doc/manpages/conf.py +++ b/doc/manpages/conf.py @@ -125,7 +125,7 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = ['_build'] +exclude_patterns = ['_build', 'common-options.rst', 'epilogue.rst', 'defines.rst'] # The reST default role (used for this markup: `text`) to use for all # documents. diff --git a/doc/manpages/defines.rst b/doc/manpages/defines.rst new file mode 100644 index 0000000000..4b66d71b44 --- /dev/null +++ b/doc/manpages/defines.rst @@ -0,0 +1,3 @@ +.. |synopsis-options| replace:: [-d|-t|-dt] [-C] [-f config-file] [-i pid-file] [-z zclient-path] [-u user] [-g group] [-A vty-addr] [-P vty-port] [-M module[:options]] [-N pathspace] [--vty_socket vty-path] [--moduledir module-path] +.. |synopsis-options-hv| replace:: [-h] [-v] +.. |seealso-programs| replace:: zebra(8), vtysh(1), ripd(8), ripngd(8), ospfd(8), ospf6d(8), bgpd(8), isisd(8), babeld(8), nhrpd(8), pimd(8), ldpd(8), eigrpd(8) diff --git a/doc/manpages/defines.txt b/doc/manpages/defines.txt deleted file mode 100644 index 4b66d71b44..0000000000 --- a/doc/manpages/defines.txt +++ /dev/null @@ -1,3 +0,0 @@ -.. |synopsis-options| replace:: [-d|-t|-dt] [-C] [-f config-file] [-i pid-file] [-z zclient-path] [-u user] [-g group] [-A vty-addr] [-P vty-port] [-M module[:options]] [-N pathspace] [--vty_socket vty-path] [--moduledir module-path] -.. |synopsis-options-hv| replace:: [-h] [-v] -.. |seealso-programs| replace:: zebra(8), vtysh(1), ripd(8), ripngd(8), ospfd(8), ospf6d(8), bgpd(8), isisd(8), babeld(8), nhrpd(8), pimd(8), ldpd(8), eigrpd(8) diff --git a/doc/manpages/eigrpd.rst b/doc/manpages/eigrpd.rst index ef269b1151..bc824468d0 100644 --- a/doc/manpages/eigrpd.rst +++ b/doc/manpages/eigrpd.rst @@ -2,7 +2,7 @@ EIGRPD ****** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: eigrpd SYNOPSIS diff --git a/doc/manpages/isisd.rst b/doc/manpages/isisd.rst index 6926d56051..68761f642c 100644 --- a/doc/manpages/isisd.rst +++ b/doc/manpages/isisd.rst @@ -2,7 +2,7 @@ ISISD ***** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: isisd SYNOPSIS diff --git a/doc/manpages/ldpd.rst b/doc/manpages/ldpd.rst index e01027d1f7..113f06673e 100644 --- a/doc/manpages/ldpd.rst +++ b/doc/manpages/ldpd.rst @@ -2,7 +2,7 @@ LDPD **** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: ldpd SYNOPSIS diff --git a/doc/manpages/nhrpd.rst b/doc/manpages/nhrpd.rst index 8a2cb25611..cae01c677b 100644 --- a/doc/manpages/nhrpd.rst +++ b/doc/manpages/nhrpd.rst @@ -2,7 +2,7 @@ NHRPD ***** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: nhrpd SYNOPSIS diff --git a/doc/manpages/ospf6d.rst b/doc/manpages/ospf6d.rst index 2328d240ae..cfc6860d5c 100644 --- a/doc/manpages/ospf6d.rst +++ b/doc/manpages/ospf6d.rst @@ -2,7 +2,7 @@ OSPF6D ****** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: ospf6d SYNOPSIS diff --git a/doc/manpages/ospfd.rst b/doc/manpages/ospfd.rst index 50ee503730..6e4d093f69 100644 --- a/doc/manpages/ospfd.rst +++ b/doc/manpages/ospfd.rst @@ -2,7 +2,7 @@ OSPFD ***** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: ospfd SYNOPSIS diff --git a/doc/manpages/pimd.rst b/doc/manpages/pimd.rst index 98fd3a5c92..d7582668d2 100644 --- a/doc/manpages/pimd.rst +++ b/doc/manpages/pimd.rst @@ -2,7 +2,7 @@ PIMD **** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: pimd SYNOPSIS diff --git a/doc/manpages/ripd.rst b/doc/manpages/ripd.rst index 01b0223251..af4590c824 100644 --- a/doc/manpages/ripd.rst +++ b/doc/manpages/ripd.rst @@ -2,7 +2,7 @@ RIPD **** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: ripd SYNOPSIS diff --git a/doc/manpages/ripngd.rst b/doc/manpages/ripngd.rst index 2a3e14ae6f..aedd689876 100644 --- a/doc/manpages/ripngd.rst +++ b/doc/manpages/ripngd.rst @@ -2,7 +2,7 @@ RIPNGD ****** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: ripngd SYNOPSIS diff --git a/doc/manpages/vtysh.rst b/doc/manpages/vtysh.rst index 341d5eae44..38cb668e82 100644 --- a/doc/manpages/vtysh.rst +++ b/doc/manpages/vtysh.rst @@ -2,7 +2,7 @@ VTYSH ***** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: eigrpd SYNOPSIS diff --git a/doc/manpages/watchfrr.rst b/doc/manpages/watchfrr.rst index 5c18ac2e6a..f0b733298d 100644 --- a/doc/manpages/watchfrr.rst +++ b/doc/manpages/watchfrr.rst @@ -2,7 +2,7 @@ WATCHFRR ******** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: watchfrr SYNOPSIS diff --git a/doc/manpages/zebra.rst b/doc/manpages/zebra.rst index 9e5d4deb07..268b1d8645 100644 --- a/doc/manpages/zebra.rst +++ b/doc/manpages/zebra.rst @@ -2,7 +2,7 @@ ZEBRA ***** -.. include:: defines.txt +.. include:: defines.rst .. |DAEMON| replace:: zebra SYNOPSIS