Skip to content
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

build docs for PRs #1357

Merged
merged 1 commit into from Apr 20, 2016
Merged

build docs for PRs #1357

merged 1 commit into from Apr 20, 2016

Conversation

megies
Copy link
Member

@megies megies commented Apr 12, 2016

With the new Anaconda Python setup we have on our docs buildbot it would be rather unproblematic to have multiple builds running at the same time (in separate environments). I think it might be a good idea to have a cronjob running that frequently checks for updated PRs (using github API) and builds docs for them. This might especially help to judge the docs part of PRs by external contributors that do not build the docs locally for checking (for us and for them).

(A speedup of docs build time would certainly help for this one. E.g. by making client module images static and not request data via network -- at least for known to fail modules.)

Opinions? I think I'm gonna work on this when I find some time.

@megies megies added external It's not our fault! docs issues that only affect the content of documentation pages, docstrings etc labels Mar 26, 2016
@krischer
Copy link
Member

Very good idea and definitely helpful.

Regarding speeding up the tests: It might be possible to install some kind of hook or monkey patch and just record all network accesses during the doc building process and store it all in some directory. On subsequent runs that directory will be used to serve all requests and we can periodically update that repository.

We could also try to add one more travis build that just builds the docs and pushes it to some repository. I'm not sure if they would like that though.

@QuLogic
Copy link
Member

QuLogic commented Mar 26, 2016

VCR.py

@megies
Copy link
Member Author

megies commented Apr 6, 2016

PR docs builds coming in one by one right now and will get updated automatically when pushed to.

see http://docs.obspy.org/pull-requests/

(leaving this issue open because I still have to add a cronjob that removes old, closed PRs' docs)

@megies
Copy link
Member Author

megies commented Apr 6, 2016

Fence time for malformed docstrings etc. in new contributions soon is over, can be checked with one click soonish..

First manually created status message:
screenshot from 2016-04-06 18 24 09

@krischer
Copy link
Member

krischer commented Apr 6, 2016

Beautiful!

@codecov-io
Copy link

Current coverage is 86.57%

Merging #1357 into master will not affect coverage as of ccae9a0

@@            master   #1357   diff @@
======================================
  Files          369     369       
  Stmts        49908   49908       
  Branches         0       0       
  Methods          0       0       
======================================
  Hit          43210   43210       
  Partial          0       0       
  Missed        6698    6698       

Review entire Coverage Diff as of ccae9a0

Powered by Codecov. Updated on successful CI builds.

@megies megies merged commit 43b67fe into master Apr 20, 2016
@megies megies deleted the docs-scripts-pr branch April 20, 2016 10:24
megies added a commit that referenced this pull request Jun 19, 2016
 * docs build for PRs can be requested by putting "+DOCS" somewhere in the
   github comments
 * current docs buildbot server has relatively low inode quota, avoid again
   using up all inodes

see #1357
megies added a commit that referenced this pull request Jun 26, 2016
claudiodsf pushed a commit to claudiodsf/obspy that referenced this pull request Jun 28, 2016
 * docs build for PRs can be requested by putting "+DOCS" somewhere in the
   github comments
 * current docs buildbot server has relatively low inode quota, avoid again
   using up all inodes

see obspy#1357
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs issues that only affect the content of documentation pages, docstrings etc external It's not our fault!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants