Generate 10 minutes to Koalas as documentation#853
Merged
Conversation
HyukjinKwon
commented
Oct 1, 2019
| 'sphinx.ext.viewcode', | ||
| 'numpydoc', # handle NumPy documentation formatted docstrings. Needs to install | ||
| 'nbsphinx', # Jupyter Notebook. Needs to install | ||
| 'nbsphinx', # Converts Jupyter Notebook to reStructuredText files for Sphinx. |
Member
Author
There was a problem hiding this comment.
BTW, pandoc added at #843 seems anyway required. nbsphinx requires nbconvert which requires pandoc.
Softagram Impact Report for pull/853 (head commit: 964eb8e)⭐ Change Overview
📄 Full report
Impact Report explained. Give feedback on this report to support@softagram.com |
Codecov Report
@@ Coverage Diff @@
## master #853 +/- ##
=========================================
+ Coverage 94.17% 94.2% +0.03%
=========================================
Files 32 32
Lines 6007 6007
=========================================
+ Hits 5657 5659 +2
+ Misses 350 348 -2
Continue to review full report at Codecov.
|
Member
Author
|
I am merging this to show how it looks like in readthedocs. I am still touching documentation so please let me know if you guys have some comments. |
Member
Author
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR adds our "10 minutes to Koalas" into official documentation. This
has the changes made in this PR.
In notebook,
...and>>>are removed now. I initially wanted to usepandocright away but it couldn't the output properly. Instead, I usednbsphinxthat usesnbconvertwhich usespandoc. Withnbsphinx,...and>>>are rendered properly (withipythondirective).Sphinx extension
IPython.sphinxext.ipython_console_highlightingandipythondependency were added in order to recogniseipython3directive with reStructuredText files and Sphinx.Added the link to Jupyter notebook (Binder) to the tutorial itself.