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.

Sign up for GitHub

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

Jump to bottom

Test usage with Sphinx (in particular autodoc-typehints) #126

Open
1 task done
eonu opened this issue Dec 27, 2023 · 0 comments
Open
1 task done

Test usage with Sphinx (in particular autodoc-typehints) #126

eonu opened this issue Dec 27, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@eonu
Copy link
Owner

eonu commented Dec 27, 2023

Does this suggestion already exist?

  • This is a new feature!

Feature description

Automatic documenation for Feud-generated commands would be useful for users.

It should be tested whether Sphinx can automatically pick up Click-decorated functions.

At the same time, it may be worth testing compatibility with https://github.com/click-contrib/sphinx-click.
@eonu eonu added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@eonu