Use sphinx-codeautolink in docs?
Open
Nobody has claimed this yet.
topic-documentation
- Dominant language
- Python
- Stars
- 4.2k
- Forks
- 1.4k
- Avg merge
- 2d 15h
- Merged PRs (30d)
- 14
Description
I'm a big fan of sphinx-codeautolink 🙂
Originally posted by @Zac-HD in https://github.com/pydata/xarray/pull/6908#discussion_r963290657
This looks cool, lets add it!
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 by locating xarray's Sphinx documentation configuration and dependency/build instructions; the issue names sphinx-codeautolink but no files or entry point. Determine how it should be enabled, then verify the documentation build and generated cross-links.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100