Remove API docs from repo and autogenerate; remove hard-coded mocks

cesium-ml / cesium

Machine Learning Time-Series Platform

Other

671 stars 101 forks source link

Remove API docs from repo and autogenerate; remove hard-coded mocks #125

Closed bnaul closed 8 years ago

bnaul commented 8 years ago

The API doc code is now in doc/conf.py so that the Sphinx build generates them automatically. A little hacky, but removes the need to keep them in the repo and remember to rebuild them every time.
Mocking is now handled by monkey patching __import__ in the Sphinx build to use mocks where needed. No longer necessary to add new requirements to the mock list.
The list of modules to include in the API docs is still hard-coded; I played around with auto-generating it but it was not nearly as easy to adapt the scikit-image code as I'd hoped, so I think this is fine for now.

Drone is happy but I can't 100% know that this works until it's merged and built on readthedocs, so if you guys aren't around I may just self-merge :smiling_imp:

acrellin commented 8 years ago

The changes look good, but drone doesn't look very happy to me :disappointed:

stefanv commented 8 years ago

I wish I knew why Drone kept reporting success without completion.

bnaul commented 8 years ago

Am I in a parallel universe? I see "All checks have passed" and the log looks good...

stefanv commented 8 years ago

Perhaps Drone does run to completion but fails to store the entire output log?

acrellin commented 8 years ago

You must be in that parallel universe Stefan slipped into yesterday...

bnaul commented 8 years ago

One commit still had mltsp.datasets in conf.py and I amended that one; another time the build failed because of an internet outage? ConnectionError: HTTPConnectionPool(host='travis-wheels.scikit-image.org', port=80): Max retries exceeded. I re-built and it looks good.

stefanv commented 8 years ago

I checked the build on your branch, and Drone was happy with that one, so merging.

bnaul commented 8 years ago

Nooooooo https://readthedocs.org/projects/mltsp/builds/3578426/

bnaul commented 8 years ago

Why is it building JSON anyway?? Looks like the HTML is fine at least :weary:

stefanv commented 8 years ago

No, I'm not sure it is fine.

bnaul commented 8 years ago

stefanv commented 8 years ago

The HTML did not get uploaded, so how do we check? On Dec 18, 2015 17:30, "Brett Naul" notifications@github.com wrote:

?

— Reply to this email directly or view it on GitHub https://github.com/mltsp/mltsp/pull/125#issuecomment-165932694.

bnaul commented 8 years ago

The HTML on readthedocs right now says "Revision da86ddd5." which is this one, so I think it did get updated. Could be wrong though. Regardless the new PR should fix it.

stefanv commented 8 years ago

Last successful build was 1 day 1 hr ago. Not sure which one that was!

On Fri, Dec 18, 2015 at 6:04 PM, Brett Naul notifications@github.com wrote:

The HTML on readthedocs right now says "Revision da86ddd https://github.com/mltsp/mltsp/commit/da86ddd5e18273d55e2e3d07d2a2c9f06f823210." which is this one, so I think it did get updated. Could be wrong though. Regardless the new PR should fix it.

— Reply to this email directly or view it on GitHub https://github.com/mltsp/mltsp/pull/125#issuecomment-165935542.