chpldoc DistributedFFT - Githubissues

npadmana / DistributedFFT

6 stars 2 forks source link

chpldoc DistributedFFT #45

Open npadmana opened 4 years ago

npadmana commented 4 years ago

As I was updating code, I realized it would be useful if DistributedFFT was chpldoc-ed.

We could also host the page on github, making it easier to access.

[x] First pass at documentation
[ ] Have Travis add documentation

ronawho commented 4 years ago

👍 For docs hosted on github-pages. I wonder how hard it would be to have a CI auto-generate the docs with commits or at least warn you that the docs are out of date.

edit:

https://docs.travis-ci.com/user/deployment/pages/

npadmana commented 4 years ago

The front page now has documentation. I'm going to leave this issue open to add automatic page generation, but that's not a big deal.