readthedocs / readthedocs/sphinx-autoapi
Hook for modifying method signatures
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 494
- Forks
- 147
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
Thanks for this plugin, it's really great!
I have a package which uses a class decorator to modify some methods of a class. Specifically it wraps coroutines in a sync wrapper.
When documenting with sphinx-autoapi the methods still show as async despite being replaced by a sync method by the decorator. I don't expect the parser to handle this, it's definitely an edge case, but I wondered if there was an event I could hook so I can write a plugin to fix this on my end?
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
The issue does not name a source file or test. Start by reviewing sphinx-autoapi's extension and event-hook APIs to find where documented method signatures can be adjusted; done means a plugin can change the reported async signature without modifying the parser itself.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100