New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Push the docs from Circle CI into github #268

Merged
merged 3 commits into from Jul 29, 2017

Conversation

Projects
None yet
3 participants
@Titan-C
Member

Titan-C commented Jul 15, 2017

Read the docs has built our docs for a long time, and it has some limitations. For example we can not build the examples gallery for mayavi. And with PR #244, we need to have the jupyter notebooks on a github repository to use binder.

This PR builds the documentation on CircleCI and if succesful it pushed the results to github pages.
Now the build address is
https://sphinx-gallery.github.io
For the moment it will only build master branch.
I image we can slowly move towards this website and drop readthedocs.

Titan-C added some commits Jul 15, 2017

@GaelVaroquaux

This comment has been minimized.

Contributor

GaelVaroquaux commented Jul 15, 2017

@choldgraf

This comment has been minimized.

Contributor

choldgraf commented Jul 15, 2017

Another option would be to use a tool such as doctr:

https://github.com/drdoctr/doctr

You can run sphinx as a part of the build process, and then configure doctr to push to gh-pages if the build completes. Sounds like this works as well too, just throwing it out there :-)

@Titan-C

This comment has been minimized.

Member

Titan-C commented Jul 29, 2017

I had no idea of doctr. Nevertheless there are some advantages in doing the push from Circle CI, namely that I can see the build.

@Titan-C

This comment has been minimized.

Member

Titan-C commented Jul 29, 2017

I'll merge this, to also launch a build with the latest release of the gallery.

@Titan-C Titan-C merged commit 6363bb2 into master Jul 29, 2017

5 checks passed

ci/circleci Your tests passed on CircleCI!
Details
continuous-integration/appveyor/branch AppVeyor build succeeded
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@Titan-C Titan-C deleted the push_doc branch Jul 29, 2017

@choldgraf

This comment has been minimized.

Contributor

choldgraf commented Jul 29, 2017

+1 - there's definitely a benefit to using circleCI to build the docs

@choldgraf

This comment has been minimized.

Contributor

choldgraf commented Jul 29, 2017

(and doctr is new but useful! worth keeping an eye on it in the future.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment