Skip to content

kpt/symmetry/dipole documentation update#16

Merged
nickhine merged 12 commits intoonetep-devel:mainfrom
Chengcheng-Xiao:doc_update
Nov 21, 2025
Merged

kpt/symmetry/dipole documentation update#16
nickhine merged 12 commits intoonetep-devel:mainfrom
Chengcheng-Xiao:doc_update

Conversation

@Chengcheng-Xiao
Copy link
Contributor

This PR:

  • Updates documentation on k-point related keywords.
  • Add documentation on dipole correction.
  • Aesthetic updates:
    • added ONETEP logo (will also update the tutorial page so they go hand-in-hand)
    • dded favicon
    • updated author list and version.

A PDF version can be found here: ONETEP_Documentation.pdf

@Chengcheng-Xiao
Copy link
Contributor Author

Chengcheng-Xiao commented Nov 21, 2025

tagging @nickhine for a quick look and and merge :)

Copy link
Contributor

@nickhine nickhine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - thanks for documenting it.

@nickhine nickhine merged commit 3823cc2 into onetep-devel:main Nov 21, 2025
2 checks passed
@nickhine
Copy link
Contributor

I'm getting an error in the deploy step:
Could not import extension sphinx_favicon (exception: No module named 'sphinx_favicon')

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

Successfully merging this pull request may close these issues.

2 participants