-
Notifications
You must be signed in to change notification settings - Fork 57
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Process events #126
Process events #126
Conversation
Currently _format_subcommand takes a command, instead of a context, as a parameter. If this is changed, the event could be re-added for it as well.
Ideally events would be documented with the 'event' directive, but this directive would need to be copied over from the Sphinx conf.py, and is not officially supported. https://github.com/sphinx-doc/sphinx/blob/7.1.x/doc/conf.py#L238
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks reasonable to me. Two small nits inline but otherwise I'm a-okay with this
Just the style issues to fix now. You can do this by installing and running pre-commit.
That will automatically run |
Should be done, after a bit of confusion I realized that this branch doesn't have the latest changes to the |
@stephenfin any plans on releasing this to PyPI? 👀 |
Good point. This will be released in 5.0.0 shortly. |
Summary
Add Sphinx events to post-process generated command documentation.
Tasks
reno
)tox
)Further details