Skip to content

Commit a36b4d5

Browse files
authored
Merge pull request #16 from CAM-Gerlach/revise-config-docstrings
Integrate revised docstrings in spyder.api.config module
2 parents e4da61c + 8c11cfb commit a36b4d5

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

docs/conf.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,10 @@
128128
("py:class", "asyncio.events.AbstractEventLoop"),
129129
("py:class", "concurrent.futures._base.Future"),
130130
# Type aliases don't work properly in Sphinx <9
131+
("py:class", "BasicTypes"),
132+
("py:class", "spyder.api.config.mixins.BasicTypes"),
133+
("py:class", "ConfigurationKeyOrList"),
134+
("py:class", "spyder.api.config.decorators.ConfigurationKeyOrList"),
131135
("py:class", "LoopID"),
132136
("py:class", "OptionSet"),
133137
("py:class", "spyder.api.preferences.OptionSet"),
@@ -288,6 +292,14 @@
288292
# Configure type aliases for signatures
289293
autodoc_type_aliases = {
290294
# Actual type aliases
295+
"BasicTypes": "spyder.api.config.mixins.BasicTypes",
296+
"ConfigurationKey": "spyder.config.types.ConfigurationKey",
297+
"ConfigurationKeyList": (
298+
"spyder.api.config.decorators.ConfigurationKeyList"
299+
),
300+
"ConfigurationKeyOrList": (
301+
"spyder.api.config.decorators.ConfigurationKeyOrList"
302+
),
291303
"LoopID": "spyder.api.asyncdispatcher.LoopID",
292304
"OptionSet": "spyder.api.preferences.OptionSet",
293305
# Ref name aliases

0 commit comments

Comments
 (0)