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

Documentation #39

Merged
merged 5 commits into from
Oct 1, 2020
Merged

Documentation #39

merged 5 commits into from
Oct 1, 2020

Conversation

nils-braun
Copy link
Collaborator

@nils-braun nils-braun commented Sep 17, 2020

Added documentation and readthedocs integration. Currently available at https://dask-sql.readthedocs.io/en/feature-documentation/index.html.

@kyprifog Would you mind having a look into the created documentation and tell me, if you think there is something missing? Would be very nice!

@codecov-commenter
Copy link

codecov-commenter commented Sep 17, 2020

Codecov Report

Merging #39 into main will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##              main       #39   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           23        23           
  Lines          620       620           
  Branches        82        82           
=========================================
  Hits           620       620           
Impacted Files Coverage Δ
dask_sql/context.py 100.00% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ac23275...47ab5d6. Read the comment docs.

@nils-braun
Copy link
Collaborator Author

I will merge this PR now, so that the deviation between the documentation and the actual code does not increase that much.
If someone would like to comment later, I am more than happy to hear any thoughts on the docu!

@nils-braun nils-braun merged commit 429e823 into main Oct 1, 2020
@nils-braun nils-braun deleted the feature/documentation branch October 1, 2020 19:52
@mrocklin
Copy link

mrocklin commented Oct 2, 2020 via email

nils-braun added a commit that referenced this pull request Oct 2, 2020
@nils-braun nils-braun mentioned this pull request Oct 2, 2020
@nils-braun
Copy link
Collaborator Author

Thanks @mrocklin, that makes sense. I have added it in #52

nils-braun added a commit that referenced this pull request Oct 3, 2020
* Improved documentation

* Use the dask-sphinx-theme as mentioned in #39
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.

3 participants