astropy / astropy/sphinx-automodapi

Freeze during generation of HTML (with typing)

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

Description

Consider the following source `bar.py`:

```
import typing

class Bar:
def type_info():
return None

ROW_ANNOTATION = typing.Tuple[
str]
```

`conf.py`:

```
extensions = [
'sphinx_automodapi.automodapi',
]
```

`index.rst`:

```
.. automodapi:: bar
```

After command `PYTHONPATH=. sphinx-build -b html . html_python` sphix-automodapi hangs with the following output:

```
PYTHONPATH=. sphinx-build -b html . html_python
Running Sphinx v5.3.0+/a5588443
loading pickled environment... done
[autosummary] generating autosummary for: api/bar.Bar.rst, index.rst
[automodsumm] index.rst: found 1 automodsumm entries to generate
building [mo]: targets for 0 po files that are out of date
building [html]: targets for 2 source files that are out of date
updating environment: [extensions changed ('sphinx_automodapi.automodapi')] 2 added, 0 changed, 0 removed
reading sources... [ 50%] api/bar.Bar
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Reproduce the hang with bar.py, conf.py, and index.rst using the shown PYTHONPATH=. sphinx-build -b html . html_python command. Start by examining the automodapi-generated api/bar.Bar.rst and the build output around reading sources at 50%. Done means HTML generation completes for the provided typing.Tuple example without freezing.

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
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.