Skip to content

Commit

Permalink
intersphinx, fixup of f3d23b
Browse files Browse the repository at this point in the history
  • Loading branch information
jakobandersen committed Apr 13, 2024
1 parent e812dd9 commit 5e39f15
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion sphinx/domains/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,16 @@ def intersphinx_add_entries_v2(self, store: Any,
that should not be inspected by the domain, but merely returned as a result
of reference resolution.
The domain must store the given data in the given *store*,
For example, for Python the data could look like the following.
.. code-block:: python
data = {
'class': {'pkg.mod.Foo': SomeIntersphinxData(...)},
'method': {'pkg.mod.Foo.bar': SomeIntersphinxData(...)},
}
The domain must store the given inner intersphinx data in the given *store*,
in whichever way makes sense for later reference resolution.
This *store* was initially a copy of :attr:`initial_intersphinx_inventory`.
Expand Down

0 comments on commit 5e39f15

Please sign in to comment.