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 133 forks source link

Make docs incorporate READMEs #314

Open matt-gardner opened 7 years ago

matt-gardner commented 7 years ago

We have a few places under doc/ where we've written explanations of things. Those explanations really should be in READMEs in the code, and just read from the README and put into doc/, instead of duplicated in both places.

I don't know if this is easy or hard, because I don't know enough about how sphinx works, or how ReadTheDocs actually builds our docs for each commit. It's probably hard.

nelson-liu commented 7 years ago

This is probably not too hard. Here's an example of how scikit-learn does it:

matt-gardner commented 7 years ago

Nice, thanks Nelson! It probably means that we'd need to move to RST instead of markdown everywhere, though... I was hoping to go the other way, but I could live with it if it gives us nicer docs.

matt-gardner commented 7 years ago

There might be a way to combine the two: https://github.com/sphinx-doc/sphinx/issues/2840#issuecomment-284863143.