添加参考域

本教程的目的是说明角色，指令和域。完成后，我们将能够使用此扩展来描述食谱并从我们文档的其他地方引用该食谱。

备注

本教程基于首先在 opensource.com 上发布的指南，并在得到原始作者许可的情况下提供。

概述

我们希望扩展可以将以下内容添加到Sphinx中：

  • recipe directive，包含一些描述食谱步骤的内容，及一个 :contains: 选项，突出显示食谱的主要成分。

  • ref role，提供对食谱本身的交叉引用。

  • recipe domain，它使我们可以将上述角色和领域以及索引等东西结合在一起。

为此，我们需要在 Sphinx 中添加以下元素：

  • 一个名为 recipe 的新指令

  • 新索引使我们可以参考成分和食谱

  • 一个名为 recipe 的新域，其中将包含 recipe 指令和 ref 角色

系统需求

我们需要与 上篇教程 中相同的设置。这一次，我们将把扩展放在名为 recipe.py 的文件中。

这是您将获得的文件夹结构的示例：

└── source
    ├── _ext
    │   └── recipe.py
    ├── conf.py
    └── index.rst

编写插件

打开 recipe.py 并将以下代码粘贴到其中，我们将在稍后详细解释所有这些代码：

  1from collections import defaultdict
  2
  3from docutils.parsers.rst import directives
  4
  5from sphinx import addnodes
  6from sphinx.application import Sphinx
  7from sphinx.directives import ObjectDescription
  8from sphinx.domains import Domain, Index
  9from sphinx.roles import XRefRole
 10from sphinx.util.nodes import make_refnode
 11from sphinx.util.typing import ExtensionMetadata
 12
 13
 14class RecipeDirective(ObjectDescription):
 15    """A custom directive that describes a recipe."""
 16
 17    has_content = True
 18    required_arguments = 1
 19    option_spec = {
 20        'contains': directives.unchanged_required,
 21    }
 22
 23    def handle_signature(self, sig, signode):
 24        signode += addnodes.desc_name(text=sig)
 25        return sig
 26
 27    def add_target_and_index(self, name_cls, sig, signode):
 28        signode['ids'].append('recipe' + '-' + sig)
 29        if 'contains' in self.options:
 30            ingredients = [x.strip() for x in self.options.get('contains').split(',')]
 31
 32            recipes = self.env.get_domain('recipe')
 33            recipes.add_recipe(sig, ingredients)
 34
 35
 36class IngredientIndex(Index):
 37    """A custom index that creates an ingredient matrix."""
 38
 39    name = 'ingredient'
 40    localname = 'Ingredient Index'
 41    shortname = 'Ingredient'
 42
 43    def generate(self, docnames=None):
 44        content = defaultdict(list)
 45
 46        recipes = {
 47            name: (dispname, typ, docname, anchor)
 48            for name, dispname, typ, docname, anchor, _ in self.domain.get_objects()
 49        }
 50        recipe_ingredients = self.domain.data['recipe_ingredients']
 51        ingredient_recipes = defaultdict(list)
 52
 53        # flip from recipe_ingredients to ingredient_recipes
 54        for recipe_name, ingredients in recipe_ingredients.items():
 55            for ingredient in ingredients:
 56                ingredient_recipes[ingredient].append(recipe_name)
 57
 58        # convert the mapping of ingredient to recipes to produce the expected
 59        # output, shown below, using the ingredient name as a key to group
 60        #
 61        # name, subtype, docname, anchor, extra, qualifier, description
 62        for ingredient, recipe_names in ingredient_recipes.items():
 63            for recipe_name in recipe_names:
 64                dispname, typ, docname, anchor = recipes[recipe_name]
 65                content[ingredient].append((
 66                    dispname,
 67                    0,
 68                    docname,
 69                    anchor,
 70                    docname,
 71                    '',
 72                    typ,
 73                ))
 74
 75        # convert the dict to the sorted list of tuples expected
 76        content = sorted(content.items())
 77
 78        return content, True
 79
 80
 81class RecipeIndex(Index):
 82    """A custom index that creates an recipe matrix."""
 83
 84    name = 'recipe'
 85    localname = 'Recipe Index'
 86    shortname = 'Recipe'
 87
 88    def generate(self, docnames=None):
 89        content = defaultdict(list)
 90
 91        # sort the list of recipes in alphabetical order
 92        recipes = self.domain.get_objects()
 93        recipes = sorted(recipes, key=lambda recipe: recipe[0])
 94
 95        # generate the expected output, shown below, from the above using the
 96        # first letter of the recipe as a key to group thing
 97        #
 98        # name, subtype, docname, anchor, extra, qualifier, description
 99        for _name, dispname, typ, docname, anchor, _priority in recipes:
100            content[dispname[0].lower()].append((
101                dispname,
102                0,
103                docname,
104                anchor,
105                docname,
106                '',
107                typ,
108            ))
109
110        # convert the dict to the sorted list of tuples expected
111        content = sorted(content.items())
112
113        return content, True
114
115
116class RecipeDomain(Domain):
117    name = 'recipe'
118    label = 'Recipe Sample'
119    roles = {
120        'ref': XRefRole(),
121    }
122    directives = {
123        'recipe': RecipeDirective,
124    }
125    indices = {
126        RecipeIndex,
127        IngredientIndex,
128    }
129    initial_data = {
130        'recipes': [],  # object list
131        'recipe_ingredients': {},  # name -> object
132    }
133    data_version = 0
134
135    def get_full_qualified_name(self, node):
136        return f'recipe.{node.arguments[0]}'
137
138    def get_objects(self):
139        yield from self.data['recipes']
140
141    def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
142        match = [
143            (docname, anchor)
144            for name, sig, typ, docname, anchor, prio in self.get_objects()
145            if sig == target
146        ]
147
148        if len(match) > 0:
149            todocname = match[0][0]
150            targ = match[0][1]
151
152            return make_refnode(builder, fromdocname, todocname, targ, contnode, targ)
153        else:
154            print('Awww, found nothing')
155            return None
156
157    def add_recipe(self, signature, ingredients):
158        """Add a new recipe to the domain."""
159        name = f'recipe.{signature}'
160        anchor = f'recipe-{signature}'
161
162        self.data['recipe_ingredients'][name] = ingredients
163        # name, dispname, type, docname, anchor, priority
164        self.data['recipes'].append((
165            name,
166            signature,
167            'Recipe',
168            self.env.current_document.docname,
169            anchor,
170            0,
171        ))
172
173
174def setup(app: Sphinx) -> ExtensionMetadata:
175    app.add_domain(RecipeDomain)
176
177    return {
178        'version': '0.1',
179        'parallel_read_safe': True,
180        'parallel_write_safe': True,
181    }

让我们逐步看一下该扩展的每一部分，以解释发生了什么。

指令类

首先要检查的是 RecipeDirective 指令：

 1class RecipeDirective(ObjectDescription):
 2    """A custom directive that describes a recipe."""
 3
 4    has_content = True
 5    required_arguments = 1
 6    option_spec = {
 7        'contains': directives.unchanged_required,
 8    }
 9
10    def handle_signature(self, sig, signode):
11        signode += addnodes.desc_name(text=sig)
12        return sig
13
14    def add_target_and_index(self, name_cls, sig, signode):
15        signode['ids'].append('recipe' + '-' + sig)
16        if 'contains' in self.options:
17            ingredients = [x.strip() for x in self.options.get('contains').split(',')]
18
19            recipes = self.env.get_domain('recipe')
20            recipes.add_recipe(sig, ingredients)

与 使用角色和指令扩展语法 和 对构建过程进行扩展 不同，此指令不是从 docutils.parsers.rst.Directive 派生的，也没有定义 run 方法。相反，它派生自 sphinx.directives.ObjectDescription 并定义了 handle_signature 和 add_target_and_index 方法。这是因为 ObjectDescription 是一个专用指令，旨在描述类，函数或在我们的情况下，食谱等内容。更具体地说，handle_signature 实现了解析指令的签名并将对象的名称和类型传递给其超类，而 add_target_and_index 则为此节点添加了一个目标（以链接到）和索引条目。

我们还看到该指令定义了 has_content， required_arguments 和 option_spec。与 上篇教程 中添加的 TodoDirective 指令不同，此指令采用单个参数，即食谱名称，以及一个选项 contains，除了正文中的嵌套 reStructuredText 之外。

索引类

 1class IngredientIndex(Index):
 2    """A custom index that creates an ingredient matrix."""
 3
 4    name = 'ingredient'
 5    localname = 'Ingredient Index'
 6    shortname = 'Ingredient'
 7
 8    def generate(self, docnames=None):
 9        content = defaultdict(list)
10
11        recipes = {
12            name: (dispname, typ, docname, anchor)
13            for name, dispname, typ, docname, anchor, _ in self.domain.get_objects()
14        }
15        recipe_ingredients = self.domain.data['recipe_ingredients']
16        ingredient_recipes = defaultdict(list)
17
18        # flip from recipe_ingredients to ingredient_recipes
19        for recipe_name, ingredients in recipe_ingredients.items():
20            for ingredient in ingredients:
21                ingredient_recipes[ingredient].append(recipe_name)
22
23        # convert the mapping of ingredient to recipes to produce the expected
24        # output, shown below, using the ingredient name as a key to group
25        #
26        # name, subtype, docname, anchor, extra, qualifier, description
27        for ingredient, recipe_names in ingredient_recipes.items():
28            for recipe_name in recipe_names:
29                dispname, typ, docname, anchor = recipes[recipe_name]
30                content[ingredient].append((
31                    dispname,
32                    0,
33                    docname,
34                    anchor,
35                    docname,
36                    '',
37                    typ,
38                ))
39
40        # convert the dict to the sorted list of tuples expected
41        content = sorted(content.items())
42
43        return content, True

 1class RecipeIndex(Index):
 2    """A custom index that creates an recipe matrix."""
 3
 4    name = 'recipe'
 5    localname = 'Recipe Index'
 6    shortname = 'Recipe'
 7
 8    def generate(self, docnames=None):
 9        content = defaultdict(list)
10
11        # sort the list of recipes in alphabetical order
12        recipes = self.domain.get_objects()
13        recipes = sorted(recipes, key=lambda recipe: recipe[0])
14
15        # generate the expected output, shown below, from the above using the
16        # first letter of the recipe as a key to group thing
17        #
18        # name, subtype, docname, anchor, extra, qualifier, description
19        for _name, dispname, typ, docname, anchor, _priority in recipes:
20            content[dispname[0].lower()].append((
21                dispname,
22                0,
23                docname,
24                anchor,
25                docname,
26                '',
27                typ,
28            ))
29
30        # convert the dict to the sorted list of tuples expected
31        content = sorted(content.items())
32
33        return content, True

IngredientIndex 和 RecipeIndex 都是从 Index 派生的。 它们实现自定义逻辑以生成定义索引的值的元组。 注意“RecipeIndex”是一个只有一个条目的简单索引。 扩展它以涵盖更多对象类型尚不是代码的一部分。

两个索引都使用方法 Index.generate() 来完成工作。该方法将来自我们域的信息进行组合，排序，然后以Sphinx接受的列表结构返回。这看起来可能很复杂，但实际上只是一个元组列表，如 ('tomato'，'TomatoSoup'，'test'，'rec-TomatoSoup'...)。 有关此API的更多信息，请参阅 domain API guide。

可以通过将域名和索引 name 值组合来使用 ref 角色引用这些索引页面。例如，RecipeIndex 可以使用 :ref:`recipe-recipe` 引用，IngredientIndex 可以使用 :ref:`recipe-ingredient` 引用。

域

Sphinx 域是一个专门的容器，将角色，指令和索引等联系在一起。现在， 让我们一起看看我们在这里创建的域。

 1class RecipeDomain(Domain):
 2    name = 'recipe'
 3    label = 'Recipe Sample'
 4    roles = {
 5        'ref': XRefRole(),
 6    }
 7    directives = {
 8        'recipe': RecipeDirective,
 9    }
10    indices = {
11        RecipeIndex,
12        IngredientIndex,
13    }
14    initial_data = {
15        'recipes': [],  # object list
16        'recipe_ingredients': {},  # name -> object
17    }
18    data_version = 0
19
20    def get_full_qualified_name(self, node):
21        return f'recipe.{node.arguments[0]}'
22
23    def get_objects(self):
24        yield from self.data['recipes']
25
26    def resolve_xref(self, env, fromdocname, builder, typ, target, node, contnode):
27        match = [
28            (docname, anchor)
29            for name, sig, typ, docname, anchor, prio in self.get_objects()
30            if sig == target
31        ]
32
33        if len(match) > 0:
34            todocname = match[0][0]
35            targ = match[0][1]
36
37            return make_refnode(builder, fromdocname, todocname, targ, contnode, targ)
38        else:
39            print('Awww, found nothing')
40            return None
41
42    def add_recipe(self, signature, ingredients):
43        """Add a new recipe to the domain."""
44        name = f'recipe.{signature}'
45        anchor = f'recipe-{signature}'
46
47        self.data['recipe_ingredients'][name] = ingredients
48        # name, dispname, type, docname, anchor, priority
49        self.data['recipes'].append((
50            name,
51            signature,
52            'Recipe',
53            self.env.current_document.docname,
54            anchor,
55            0,
56        ))

关于此“recipe”域和一般域，需要注意一些有趣的事情。 首先，我们实际上通过“ directives”，“ roles”和“indices”属性在此处注册我们的指令，角色和索引，而不是通过稍后在“ setup”中进行调用。 我们还可以注意到，我们实际上不是在定义自定义角色，而是在重用 sphinx.roles.XRefRole 角色并定义 sphinx.domains.Domain.resolve_xref 方法。 此方法采用两个参数 typ 和 target，它们引用交叉引用类型及其目标名称。因为我们目前只有一种类型的节点，所以我们将使用 target 来从域的 recipes 中解析出目的地。

继续前进，我们可以看到我们定义了 initial_data 。在 initial_data 中定义的值将被复制到 env.domaindata[domain_name] 作为域的初始数据，，域实例可以通过 self.data 访问它。我们看到我们在 initial_data 中定义了两个项目： recipes 和 recipe_ingredients 。每个都包含所有定义的对象的列表（即所有食谱）和将规范成分名称映射到对象列表的哈希。我们命名对象的方式在我们的扩展中是通用的，并且在 get_full_qualified_name 方法中定义。对于创建的每个对象，规范名称为 recipe.<recipename>，其中 <recipename> 是文档编写者给对象（食谱）命名的名称。这使扩展能够使用共享同一名称的不同对象类型。拥有规范名称和对象的中心位置是一个巨大的优势。我们的索引和交叉引用代码都使用此功能。

setup()函数

As always， setup 函数是一个必需的函数，用于将扩展的各个部分连接到 Sphinx。让我们来看看此扩展的 setup 函数。

1def setup(app: Sphinx) -> ExtensionMetadata:
2    app.add_domain(RecipeDomain)
3
4    return {
5        'version': '0.1',
6        'parallel_read_safe': True,
7        'parallel_write_safe': True,
8    }

这看起来与我们习惯看到的有些不同。没有对 add_directive() 或甚至 add_role() 的调用。相反，我们对 add_domain() 进行了单次调用，后跟对 standard domain 的一些初始化。这是因为我们已经将指令，角色和索引作为指令本身的一部分进行了注册。

使用扩展

现在，您可以在整个项目中使用扩展名。例如：

index.rst
Joe's Recipes
=============

Below are a collection of my favourite recipes. I highly recommend the
:recipe:ref:`TomatoSoup` recipe in particular!

.. toctree::

   tomato-soup
tomato-soup.rst
The recipe contains `tomato` and `cilantro`.

.. recipe:recipe:: TomatoSoup
   :contains: tomato, cilantro, salt, pepper

   This recipe is a tasty tomato soup, combine all ingredients
   and cook.

需要注意的重要事项是使用 :recipe:ref: 角色来交叉引用实际上在其他地方定义的食谱（使用 :recipe:recipe: 指令）。

延伸阅读

有关更多信息，请参考 docutils 文档和 Sphinx API接口。

如果您希望在多个项目或与其他人共享您的扩展，请查看 第三方插件 部分。