如何处理'显示名称' for add_object_type?

时间:2017-04-02 13:40:28

标签: python-sphinx

我正在使用Sphinx' add_object_type为配置文件值创建自定义对象confval

add_object_type('confval', 'confval', objname='configuration value', indextemplate='pair: %s; configuration value')`

但是我有多个配置文件,它们可以具有相同的值。

考虑:

..confval:  filepath

    Description filepath in configuration file foo.cfg

..confval:  filepath

    Description filepath in configuration file bar.cfg

我现在有两个文件路径值。我可以通过将其名称更改为foo-filenamebar-filename来使其唯一,但这会更改呈现给用户的文本。

如何在保留用户看到的文本的同时为值生成唯一索引名称?

我目前的想法是添加index选项:

..confval:  filepath
    :index: foo-filepath

    Description filepath in configuration file foo.cfg

但这需要创建一个指令类。我可以使用add_object_type执行某些操作吗?

0 个答案:

没有答案