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

Update documentation #28

Open
lucydot opened this issue Mar 12, 2021 · 2 comments
Open

Update documentation #28

lucydot opened this issue Mar 12, 2021 · 2 comments
Labels
documentation Gotta luv the docs

Comments

@lucydot
Copy link
Owner

lucydot commented Mar 12, 2021

The documentation has a basic tutorial workflow. However there should be some FAQs added:

  • how to adjust the fermi level and update CBM/VBM (especially useful when there is no occupancy data)
  • how to specify a particular band/k-point when the one you want is automatically found

Also change structure of documentation so that inputs section is extended to cover various DFT calculators.
@lucydot
Copy link
Owner Author

lucydot commented May 24, 2021

After some recent PR's I should also:

  • update API documentation for Datavasprun
  • Update Jupyter notebook example of reading in vasprun.xml

@lucydot
Copy link
Owner Author

lucydot commented May 31, 2023

The documentation site is looking pretty tired in general. It would be nice to migrate this to mkdocs and mkdocstrings (for automatic documentation from docstrings a la sphinx).

@lucydot lucydot added the documentation Gotta luv the docs label May 31, 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 Gotta luv the docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@lucydot