]> git.puffer.fish Git - mirror/frr.git/commit
doc: add ability to disambiguate clicmds
authorQuentin Young <qlyoung@qlyoung.net>
Fri, 29 Sep 2023 00:11:31 +0000 (20:11 -0400)
committerQuentin Young <qlyoung@qlyoung.net>
Thu, 27 Jun 2024 18:47:30 +0000 (14:47 -0400)
commitdc00f2dc1d4d3f6435c31bf8d4777ff78b851d12
tree31710ed0ab86e8ab03927367ffb62605178c9ef5
parent5f41bb29ab006b0a4afce238719fc041e75f1b0e
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>
doc/user/conf.py