astropy / astropy/sphinx-automodapi

Intersphinx type references are causing trouble.

Open
#68 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
67
Forks
48
Avg merge
11h 52m
Merged PRs (30d)
1

Description

Hello, when I set the type of a parameter to something available through intersphinx, e.g. `:type param: cvxopt.matrix` or `:type param: cvxopt:cvxopt.matrix` where `cvxopt` was successfully fetched via intersphinx, I get the following exception:

```
File "…/.local/lib/python3.7/site-packages/sphinx_automodapi/smart_resolver.py", line 76, in missing_reference_handler
if reftarget in inventory[prefix]['py:class']:
KeyError: 'py:class'
```

This is version 0.10 installed via pip.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start at sphinx_automodapi/smart_resolver.py:76 and reproduce the failure using an intersphinx inventory containing cvxopt, with the parameter type forms shown in the issue. Trace how the inventory is accessed and verify that both references resolve without a KeyError.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.