Skip to content

MAINT: Add CircleCI #208

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

Merged
merged 2 commits into from
Apr 21, 2019
Merged

MAINT: Add CircleCI #208

merged 2 commits into from
Apr 21, 2019

Conversation

larsoner
Copy link
Collaborator

I wanted to browse and link to built docs in #197 but didn't see a way to do it. This should make it easy to view hopefully.

I don't have permissions for the NumPy org to tick the box here to enable it:

https://circleci.com/add-projects/gh/numpy

@rgommers or some other suitably permissioned person, could you enable it? Then I can iterate here until it works.

Eventually this could easily probably amended to upload to readthedocs, not sure if it's already automated or not.

@rgommers
Copy link
Member

good idea, +1

@rgommers or some other suitably permissioned person, could you enable it?

done

@larsoner
Copy link
Collaborator Author

@rgommers can you check

https://circleci.com/gh/numpy/numpydoc/edit#advanced-settings

And make sure "Build forked pull requests" is turned on? Or find a way to give me permissions for numpydoc settings and I can fight with it

@larsoner
Copy link
Collaborator Author

Oh wait, I was actually able to change it, never mind!

@larsoner
Copy link
Collaborator Author

Well that was way less painful than expected:

https://3-11639513-gh.circle-artifacts.com/0/html/index.html

Ready for review/merge from my end.

@rgommers
Copy link
Member

Code LGTM. I'll leave it open for a bit to give others the chance to comment.

I actually thought it did more than building the numpydoc readthedocs at first. What would be really helpful is to build the NumPy docs with it - that could show how things actually look; the numpydoc docs themselves are way too small for that.

@larsoner
Copy link
Collaborator Author

We could do something similar to sphinx-gallery, namely include in numpydoc docs most of the things we want to show that numpydoc is useful for.

But maybe building NumPy docs would do this anyway, with the added benefit of making sure our changes don't break at least one other doc build.

Let's do that as a separate PR, though, since it's probably going to require a bit more work.

@rgommers
Copy link
Member

Yes agree, a separate PR is better. Building NumPy docs will be less work and more benefit I think. It covers (almost) all cases I'd think.

@rgommers rgommers merged commit 0ec9e22 into numpy:master Apr 21, 2019
@rgommers
Copy link
Member

Merged, thanks @larsoner

@rgommers
Copy link
Member

Hmm this failed:

WARNING: LaTeX command 'latex' cannot be run (needed for math display), check the imgmath_latex setting
generating indices... genindex py-modindex
highlighting module code... [100%] example

writing additional pages... search
copying static files... done
copying extra files... done
dumping search index in English (code: en) ... done
dumping object inventory... done
build finished with problems, 1 warning.
Makefile:56: recipe for target 'html' failed
make: *** [html] Error 1
Exited with code 2

@larsoner larsoner deleted the circle branch April 21, 2019 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants