Skip to content
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

Merged
merged 5 commits into from
Aug 9, 2023
Merged

Conversation

coloursofnoise
Copy link
Contributor

Summary

Add Sphinx events to post-process generated command documentation.

Tasks

  • Added unit tests
  • Added documentation for new features (where applicable)
  • Added release notes (using reno)
  • Ran test suite and style checks and built documentation (tox)

Further details

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
Copy link
Member

@stephenfin stephenfin left a 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

docs/usage.rst Show resolved Hide resolved
sphinx_click/ext.py Outdated Show resolved Hide resolved
@stephenfin
Copy link
Member

Just the style issues to fix now. You can do this by installing and running pre-commit.

pip install pre-commit
pre-commit run -a

That will automatically run black for you.

@coloursofnoise
Copy link
Contributor Author

Should be done, after a bit of confusion I realized that this branch doesn't have the latest changes to the tox and pre-commit config so I just ran black manually.

@stephenfin stephenfin merged commit 18de60a into click-contrib:master Aug 9, 2023
7 checks passed
@caioariede
Copy link

@stephenfin any plans on releasing this to PyPI? 👀

@stephenfin
Copy link
Member

Good point. This will be released in 5.0.0 shortly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants