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

Documentation #30

Open
douglowe opened this issue Jan 20, 2023 · 2 comments
Open

Documentation #30

douglowe opened this issue Jan 20, 2023 · 2 comments

Comments

@douglowe
Copy link
Collaborator

douglowe commented Jan 20, 2023

To provide documentation (relatively) easily we can use the FORD tool.

I've created an example in the ford_doc branch

@douglowe
Copy link
Collaborator Author

The FORD generated example documentation has been pushed to main branch, and github-pages has been enabled.

The documentation main page is: https://lightform-group.github.io/KWN-deformation/

@douglowe
Copy link
Collaborator Author

Perhaps follow the example of projects like DBCSR

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