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

Private/dunder methods incorrectly documented in mkdocs #365

Closed
ml-evs opened this issue Jun 24, 2020 · 0 comments · Fixed by #430
Closed

Private/dunder methods incorrectly documented in mkdocs #365

ml-evs opened this issue Jun 24, 2020 · 0 comments · Fixed by #430
Labels
docs Issues pertaining to documentation. priority/low Issue or PR with a consensus of low priority

Comments

@ml-evs
Copy link
Member

ml-evs commented Jun 24, 2020

For some reason mkdocs-autodoc is including __json_encoder__() into our API docs, see e.g. the Success response model:

image
@ml-evs ml-evs added docs Issues pertaining to documentation. priority/low Issue or PR with a consensus of low priority labels Jun 24, 2020
@CasperWA CasperWA mentioned this issue Jul 29, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Issues pertaining to documentation. priority/low Issue or PR with a consensus of low priority
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Auto-generate API reference in docs and an overhaul Materials-Consortia/optimade-python-tools
1 participant
@ml-evs