allenai / deep_qa

A deep NLP library, based on Keras / tf, focused on question answering (but useful for other NLP too)
Apache License 2.0
404 stars 132 forks source link

Add scripts to run circleci doc builds #172

Closed nelson-liu closed 7 years ago

nelson-liu commented 7 years ago

This PR adds the necessary files to build our docs on circleCI. These tests will fail if sphinx is unable to build the docs (error, as opposed to many warnings) / doctests fail (though we don't have any right now).

CircleCI has a nice feature with artifacts, that lets you view the built doc as made by circleci without pushing this to master (in order to build it on readthedocs). to access the doc artifact, just access: https://${CIRCLECI_BUILD_NUM}-76925733-gh.circle-artifacts.com/0/home/ubuntu/deep_qa/doc/_build/html/index.html

note that circleci build number != github pull request number. Here's an example it built on my own fork: https://4-76925733-gh.circle-artifacts.com/0/home/ubuntu/deep_qa/doc/_build/html/index.html