Sphinx on Travis-CI

[Matt McKay]

I am trying to setup `travis` to compile our sphinx project. The issue I am having is that our sphinx execution is a long running process and I would like to use the travis cache to restore the `_build` folder between runs. There is a mechanism to do this in travis.

cache:

directories:

- $HOME/build/mmcky/<repo>/_build/

It appears to be working. At the end of an initial clean run of sphinx-build it saves the directory as a `tar.gz` archive. Next time `travis` is run it restores the directory. 

https://travis-ci.org/QuantEcon/lecture-source-py/builds/568157135?utm_source=github_status&utm_medium=notification

The issue is `sphinx` keeps thinking the targets are out of date and can't figure out what is causing it to register as out-of-date as the contents of the rst files is constant. I have tried replicating this on a local machine -- copying the `_build` directory to another location and the cache seems to be preserved when moving it back into the repo. 

Any ideas/advice would be greatly appreciated.

Thanks!

Matt

QuantEcon Project

[Eric Larson]

Try building while using the branch from this PR:

https://github.com/sphinx-doc/sphinx/pull/6419

It should say why things are being rebuilt if it's a systematic issue (e.g., changing configuration, which is not always obvious). If it just says the files are out of date even on this branch, then it's probably some `mtime` detection problem.

One other thing you could consider is trying to set up the same thing on CircleCI. It supports "Rebuild with SSH" so you can interact with the failed build afterward for much faster iteration. Some projects I work on have very long build processes, and it has been nice having these on CircleCI. It also exposes artifacts of the build fairly easily for browsing docs. See for example https://circleci.com/gh/nipy/PySurfer/272#artifacts/containers/0 and https://github.com/nipy/PySurfer/blob/master/.circleci/config.yml

HTH,

Eric

--
You received this message because you are subscribed to the Google Groups "sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sphinx-users...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/sphinx-users/a0eef8f1-14b1-4019-8d1c-b6abd766e897%40googlegroups.com.

[Matt McKay]

Thanks Eric! -- I will give all of those suggestions a try.

To unsubscribe from this group and stop receiving emails from it, send an email to sphinx...@googlegroups.com.