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

Remaining issues in API documentation #133

Open
cbrnr opened this issue Nov 30, 2022 · 0 comments
Open

Remaining issues in API documentation #133

cbrnr opened this issue Nov 30, 2022 · 0 comments

Comments

@cbrnr
Copy link
Owner

cbrnr commented Nov 30, 2022

Our API documentation looks very nice except for the following issues (left over from #126):

  • The "See Also" section should not be listed in the left TOC
  • The "Warnings" section should not be listed in the left TOC

These issues can only be addressed upstream (in griffe and python-handler repos) by adding support for "See Also", "Warnings", "Notes", and "References", see e.g. here.

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

No branches or pull requests

1 participant