search

MobleyLab / chemper

Repository for Chemical Perception Sampling Tools
MIT License
19 stars 10 forks source link

Can we "test" the docs #31

Closed bannanc closed 5 years ago

bannanc commented 6 years ago

So what I learned from the docs failing is that other than the badge on the front they fail silently, no e-mail or notification in a pull request.

I know there are some complicated tests out there in sphinx, that do things like check to see if the links work. I'm not sure if it is worth the learning curve to get one of these working right now.

However, it would be nice for the docs badge to at least be passing and be notified when it isn't or at least not let PRs be merged when it isn't.

When I have time I'm going to look into what the options are on this front.

bannanc commented 6 years ago

I set up ReadTheDocs to e-mail (well technically slack) me so I should at least get a notification when something fails.

bannanc commented 5 years ago

yes, I'll follow openforcefield's test that scrape documentation for snippets. I'll outline any plans for that in issue #77