readthedocs / readthedocs/sphinx-autoapi
Support PEP-702 style deprecations
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 494
- Forks
- 147
- Avg merge
- 9m
- Merged PRs (30d)
- 1
Description
To document my deprecation cycles, I usually use the deprecated lib. It's as simple to use as this:
from deprecated.sphinx import deprecated
@deprecated(version='1.0', reason="This function will be removed soon")
def function_three():
'''This is the function three'''
function_three() # warns
help(function_three)
as the decorator is changing the result of the help method, it's automatically adding information if the documentation is build with api-doc. with autoapi, as you don't load the method but only parse them, I think this is just getting ignored.
Would you think of a way to implement a workaround either from here or directly from their repository ?
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 with the deprecated.sphinx decorator example in the issue and trace how AutoAPI parses Python functions without importing them. Compare that behavior with api-doc's handling of the same deprecated function, then define a way for generated documentation to preserve the deprecation information and verify the resulting output.
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
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 42/100