[MRG] [DOC] Add sphinx documentation #185
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@lucyleeow where is this doc coming from? did you type all this? Can you see why CIs are red? |
|
@agramfort yes I wrote this. @maikia and I thought it would be a good idea to write some (better) documentation to record things we discover and make it easier for us to write starting kits in future. appveyor seems to be failing while running |
|
nice !
I would first do a PR to fix the CIs before merging this.
… |
Codecov Report
@@ Coverage Diff @@
## master #185 +/- ##
======================================
Coverage 77.9% 77.9%
======================================
Files 117 117
Lines 4545 4545
======================================
Hits 3541 3541
Misses 1004 1004Continue to review full report at Codecov.
|
|
@agramfort to add circleCI, it would be easiest to merge this so master has a appveyor failing is independent and we found it to be due to time out error when executing the titanic starting kit ipynb due to the Merging. |
lucyleeow
changed the title
lucyleeow
added a commit
that referenced
this pull request
Nov 8, 2019
* [DOC] Add circleci and sphinx documentation (#185) * add sphinx doc * add to using ramp workflow * add docs * create initial circleCI * amend doc * [empty] trigger circleCI * dictate branch * remove branch specification * [mrg] fixing issues with tests not passing on appveyor (#186) * Update README.md * checking the test_notebook_testing path * debugging convert_notebook * checking where exactly in execute-notebook is the problem * changed titanic starting kit not to have !command * hashing out the Executing Shell Commands (!) in jupyter notebooks * cleanup * updated link for appveyor * [MRG] [DOC] Improve circleci config (#187) * added workflows to trigger build job * add rdt theme req * store built docs as circleci artifacts * set circleci config to push to gh-pages * update docs and readme * circleci store built docs as artifacts * address agramfort comments * minor formatting
kegl
added a commit
that referenced
this pull request
Dec 2, 2019
* [DOC] Add circleci and sphinx documentation (#185) * add sphinx doc * add to using ramp workflow * add docs * create initial circleCI * amend doc * [empty] trigger circleCI * dictate branch * remove branch specification * [mrg] fixing issues with tests not passing on appveyor (#186) * Update README.md * checking the test_notebook_testing path * debugging convert_notebook * checking where exactly in execute-notebook is the problem * changed titanic starting kit not to have !command * hashing out the Executing Shell Commands (!) in jupyter notebooks * cleanup * updated link for appveyor * fixing blending * fixing blending cli * fixing blending * make blending more readable * creating training_output before using it * flake * assert cv * flake * getting rid of python 2 in travis
kegl
added a commit
that referenced
this pull request
Dec 10, 2019
* [DOC] Add circleci and sphinx documentation (#185) * add sphinx doc * add to using ramp workflow * add docs * create initial circleCI * amend doc * [empty] trigger circleCI * dictate branch * remove branch specification * [mrg] fixing issues with tests not passing on appveyor (#186) * Update README.md * checking the test_notebook_testing path * debugging convert_notebook * checking where exactly in execute-notebook is the problem * changed titanic starting kit not to have !command * hashing out the Executing Shell Commands (!) in jupyter notebooks * cleanup * updated link for appveyor * adding bagged leaderboard * flake * fixing titatnic to sklearn 0.22 * flake * fixing added newline when notebooks are executed * tests * fixing appveyor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update documentation and move from wiki to sphinx documentation.