Autosummary references problem
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
The references in autosummary preview are rendered in long hashes again.
Doc: https://pytorch-mighty.readthedocs.io/en/latest/reference/loss.html
Source: https://github.com/dizcza/pytorch-mighty/blob/master/mighty/loss/__init__.py
The workaround posted in #130, unfortunately, does not help. Now it parses the references in an overview section as [Rfe594912252b-R1] instead of [Rfe594912252b-1].
Originally posted by @dizcza in https://github.com/numpy/numpydoc/issues/214#issuecomment-723595256
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with mighty/loss/init.py and the linked autosummary preview at reference/loss.html. Reproduce the long-hash rendering and compare the overview reference output with the workaround described in issue #130. Done means references use the expected [Rfe594912252b-1] form instead of [Rfe594912252b-R1].
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
- 42/100