Enable hyperlinks to stdlib/hightime/numpy docs with intersphinx
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Python
- Stars
- 592
- Forks
- 199
- Avg merge
- 1d 16h
- Merged PRs (30d)
- 10
Description
It would be nice if the docs for methods/properties that use datetime, hightime, and NumPy types had hyperlinks. We can enable this with the intersphinx plugin. See https://github.com/ni/measurementlink-python/pull/430 for an example.
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
Compare the documentation configuration with the intersphinx example in measurementlink-python pull request 430. Identify where this repository configures Sphinx extensions and external documentation mappings, then enable links for datetime, hightime, and NumPy types. Done means the generated API docs hyperlink those referenced types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- numpy, python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100