mirror_frr/doc/user
Quentin Young dc00f2dc1d doc: add ability to disambiguate clicmds
Multiple daemons have the same CLI commands defined, but the current
directive used to document CLI commands only takes the command
definition string. Since CLI command objects can be cross-referenced
using the :clicmd: directive, and are placed in the index, each object
needs to be unique.

To accomplish this, add a custom directive. This directive extends the
directive class used by sphinx's add_object_type to add a :daemon:
option. By specifying this option where needed, the object name becomes
"(<daemon>) <definition>", disambiguating it.

Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2024-06-27 14:47:30 -04:00
..
_static doc: orange FRR theme 2019-02-18 14:39:13 +01:00
images doc: Augmented pathd documentation. 2021-10-04 18:56:47 +02:00
.gitignore doc: fix distclean 2018-05-18 19:35:24 +00:00
.readthedocs.yaml doc: fix docs path to requirements.txt 2023-11-17 12:11:09 -05:00
affinitymap.rst doc: add extended admin-group user documentation 2023-02-10 14:13:46 +01:00
babeld.rst doc: update config file doc for integrated requirement 2024-01-13 21:05:36 +00:00
basic.rst doc: Fix one spelling dissallowed to disallowed 2024-03-05 08:57:39 +02:00
bfd.rst build: nuke BFDD_CONTROL_SOCKET 2024-01-27 19:01:19 +01:00
bgp.rst doc: Add missing clear bgp ASNUM command 2024-06-05 08:35:34 +03:00
bmp.rst bgpd: add bmp loc-rib 64 bit gauge value 2024-04-26 08:12:41 +02:00
bugs.rst doc: fix dupe bug-reports label, index entry 2021-02-23 15:49:19 -05:00
conf.py doc: add ability to disambiguate clicmds 2024-06-27 14:47:30 -04:00
config-include.rst doc: update config file doc for integrated requirement 2024-01-13 21:05:36 +00:00
eigrpd.rst doc: update config file doc for integrated requirement 2024-01-13 21:05:36 +00:00
evpn.rst doc: add documentation for show vrf vni 2023-01-13 13:49:21 -08:00
extlog.rst doc: add new RFC5424 & journald logging targets 2022-01-17 00:39:00 +01:00
fabricd.rst *: remove *.conf.sample files 2021-04-09 13:14:30 -04:00
filter.rst lib: add "json" option to "show ip[v6] prefix-list" 2021-08-02 17:19:45 -03:00
flowspec.rst doc: remove 'no' form of commands 2021-02-22 14:38:21 -05:00
frr-reload.rst doc: add docs for frr-reload.py options 2020-05-26 19:14:12 +02:00
glossary.rst
grpc.rst doc: initial documentation for gRPC 2020-08-10 16:39:06 -03:00
index.rst doc: include affinity-maps into index 2023-04-17 11:25:25 +02:00
installation.rst doc: Add reloading script into Python dependency section 2024-06-11 15:23:24 +00:00
ipv6.rst doc: add doc for show ipv6 nd ra-interfaces 2021-06-08 15:17:22 -04:00
isisd.rst isisd: fix 'show isis route prefix-sid backup' command 2024-06-14 08:42:18 +02:00
kernel.rst doc: remove obsolete Netlink discussion, fix svi cmd doc 2021-04-30 18:10:56 -05:00
ldpd.rst doc: fix one ldp neighbor command 2024-06-15 13:56:30 +08:00
Makefile build: non-recursive doc + parallel sphinx 2018-08-30 08:06:44 +02:00
mgmtd.rst doc: add some text on native message API and notif xpath array 2024-06-07 05:50:10 -04:00
nexthop_groups.rst doc: Add nexthop_groups documentation 2022-11-04 13:34:27 -04:00
nhrpd.rst nhrpd: add cisco-authentication password support 2024-06-10 16:39:21 -07:00
ospf6d.rst ospfd: Implement non-broadcast support for point-to-multipoint networks 2024-04-02 21:34:29 +00:00
ospf_fundamentals.rst ospfd: Implement non-broadcast support for point-to-multipoint networks 2024-04-02 21:34:29 +00:00
ospfd.rst ospfd: Improve OSPF neighbor retransmission list granularity and precision 2024-06-20 15:31:07 +00:00
overview.rst doc: Add RFC 9494 to the supported RFC list 2023-12-03 19:27:11 +02:00
packet-dumps.rst doc: reorganize into multiple toctrees 2018-06-08 07:54:25 +00:00
pathd.rst pathd: add 'show sr-te pcep session json' support 2024-01-18 22:04:05 +01:00
pbr.rst doc: update config file doc for integrated requirement 2024-01-13 21:05:36 +00:00
pim.rst pimd: fix dr-priority range 2024-05-08 21:21:30 +02:00
pimv6.rst pimd: fix dr-priority range 2024-05-08 21:21:30 +02:00
prior-config-files.rst doc: update config file doc for integrated requirement 2024-01-13 21:05:36 +00:00
requirements.txt doc: restore frr docs theme 2023-11-16 18:44:28 -05:00
ripd.rst doc: update config file doc for integrated requirement 2024-01-13 21:05:36 +00:00
ripngd.rst lib: Allow doing match/set tag untagged 2024-05-10 09:50:18 +03:00
routemap.rst lib: Allow doing match/set tag untagged 2024-05-10 09:50:18 +03:00
routeserver.rst doc: replace the import/export keywords for in/out 2022-06-14 15:39:48 +02:00
rpki.rst bgpd: Rename SERVER_PUBKEY to KNOWN_HOSTS_PATH 2024-05-21 14:23:16 +03:00
scripting.rst *: Fix spelling of overriden 2022-04-19 08:27:02 -04:00
setup.rst doc: Adding a description for a new option 2022-11-23 10:19:33 +01:00
sharp.rst sharpd: Allow sharpd to listen to neighbor events 2024-01-22 12:19:20 -05:00
snmp.rst bgp: fix bgp4v2 MIB NLRI INDEX format and order 2023-11-08 21:20:17 +01:00
snmptrap.rst doc: [no] bgp snmp traps <rfc4273|bgp4-mibv2> 2023-10-24 17:16:47 +02:00
static.rst doc: update config file doc for integrated requirement 2024-01-13 21:05:36 +00:00
subdir.am doc: Add documentation for MGMT daemon 2023-03-21 22:09:10 -04:00
Useful_Sysctl_Settings.md doc: update VRF support description 2021-05-31 22:12:55 +03:00
vnc.rst doc: remove 'no' form of commands 2021-02-22 14:38:21 -05:00
vrrp.rst doc: update config file doc for integrated requirement 2024-01-13 21:05:36 +00:00
vtysh.rst doc: update config file doc for integrated requirement 2024-01-13 21:05:36 +00:00
watchfrr.rst doc: remove 'no' form of commands 2021-02-22 14:38:21 -05:00
wecmp_linkbw.rst doc: automatically generate index entries for cli 2021-02-22 14:38:21 -05:00
zebra.rst doc: Add documentation for SRv6 SID formats CLI 2024-06-13 14:54:16 +02:00