mirror_frr/doc
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
..
accords accords: CLI coloring 2022-12-13 18:41:25 +01:00
developer doc: reformat Sphinx conf.py files 2024-06-26 15:44:08 -04:00
extra *: auto-convert to SPDX License IDs 2023-02-09 14:09:11 +01:00
figures doc: add diagram of oper-state queries. 2024-01-04 05:36:14 +00:00
licenses lib: SPDX License ID on skiplist code 2023-02-09 14:09:11 +01:00
manpages zebra: Make main routing table (RT_TABLE_MAIN) configurable 2023-08-22 15:29:07 +02:00
mpls *: cleanup .gitignore files 2018-09-08 21:30:42 +02:00
user doc: add ability to disambiguate clicmds 2024-06-27 14:47:30 -04:00
.gitignore *: cleanup .gitignore files 2018-09-08 21:30:42 +02:00
Makefile build: non-recursive doc + parallel sphinx 2018-08-30 08:06:44 +02:00
subdir.am doc: start of mgmtd developer doc 2023-06-19 18:13:37 -04:00