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

BUG: Documentation currently does not show all the subpackages and modules available in atomate2 #851

Open
AntObi opened this issue May 14, 2024 · 0 comments

Comments

@AntObi
Copy link

AntObi commented May 14, 2024

Describe the bug

The API reference in the documentation (https://materialsproject.github.io/atomate2/reference/index.html) currently does not show the whole atomate2 API. For example, the CP2K, qchem and forcefields modules cannot be found in the live documentation. New users to atomate2 would only be able to find these within the source code in the GitHub repository.

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://materialsproject.github.io/atomate2/reference/index.html
  2. See that there are missing modules in the API reference

Provide any example files that are needed to reproduce the error,
especially if the bug pertains to parsing of a file.

Expected behavior
image
The expected behavior should be that all the modules should be shown in the API reference as shown on the right in the screenshot above

I've created PR #850 to solve this problem.

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