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

Docs builds with new mkdocstrings handler ignore filters #1934

Closed
ml-evs opened this issue Jan 11, 2024 · 1 comment · Fixed by #1936
Closed

Docs builds with new mkdocstrings handler ignore filters #1934

ml-evs opened this issue Jan 11, 2024 · 1 comment · Fixed by #1936
Labels
docs Issues pertaining to documentation.

Comments

@ml-evs
Copy link
Member

ml-evs commented Jan 11, 2024

As can be seen from the latest deployed docs, e.g., https://www.optimade.org/optimade-python-tools/1.0.2/api_reference/models/structures/, any import from the optimade package in a given file is also getting rendered in that file's docs. This wasn't the case with the "legacy" renderer. We should revert this for now and redeploy the latest docs versions using the legacy renderer.
@ml-evs ml-evs added the docs Issues pertaining to documentation. label Jan 11, 2024
@ml-evs
Copy link
Member Author

ml-evs commented Jan 11, 2024

Nevermind, this was caused by a mkdocs config file mistake where members: true.

@ml-evs ml-evs closed this as completed Jan 11, 2024
This was referenced Jan 11, 2024
Merged
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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

mkdocs fix global setting of members: true Materials-Consortia/optimade-python-tools
1 participant
@ml-evs