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

Automate documentation build #64

Open
ketch opened this issue Aug 9, 2014 · 1 comment
Open

Automate documentation build #64

ketch opened this issue Aug 9, 2014 · 1 comment
Assignees
Labels

Comments

@ketch
Copy link
Member

ketch commented Aug 9, 2014

We keep running into issues with the documentation, and I think most of them could be avoided if we had an automated build that updated clawpack.github.io. Also, it might be helpful to have some tests, though I haven't thought about it much. At a minimum, we should do

make doctest
@ketch
Copy link
Member Author

ketch commented Feb 8, 2015

Even better: we could have Travis build and push our docs! Here's one approach:

http://blog.teracy.com/2013/08/09/automatic-sphinx-docs-deployment-with-sphinx-deployment/

One stumbling block is that we need to be able to build the codes and run all examples for the galleries. But maybe we could have an option to not update the gallery, and do that manually when necessary.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant