Have edit links for dynamically-generated documentation pages point to their source files
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 29
- Forks
- 9
- Avg merge
- 9d 9h
- Merged PRs (30d)
- 8
Description
This is possible. See for example here:
https://github.com/vispy/vispy/blob/6855a9c6ab1058e290d7bdfdce83551c5b18c343/doc/conf.py#L138-L180
It will eliminate the need for placeholder files and associated hooks.
Contributor guide
No contributing guide indexed for this repository
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 reviewing the documentation configuration, using the linked vispy doc/conf.py example as a reference for dynamically generated pages. Identify how PyRenew currently creates edit links and placeholder files; done means links point to the generating source files and the placeholder files and associated hooks are no longer needed.
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
- Mostly clear
- Newbie friendliness
- 35/100