Generate official documentation with MkDocs - Githubissues

bobleesj / cifkit

High-throughput .cif analysis made easy. Visit: https://bobleesj.github.io/cifkit/

https://bobleesj.github.io/cifkit/

MIT License

11 stars 0 forks source link

Generate official documentation with MkDocs #4

Open bobleesj opened 2 months ago

bobleesj commented 2 months ago

Discussions to add:

[ ] Discuss CN method (best method vs. bad method image)
[ ] Include software architecture (a diagram)
[ ] API documentation (generated with MkDocs and provide docstrings)
[ ] Include histogram generation
[x] Discuss atomic mixing info (file-level, and pair-level)
[x] Include preprocessing info (author removal, label replacement, loop values)

Format:

[x] Modify color theme
[ ] Change favicon
[x] Include Google Codelab link
[ ] Include how to modify the document