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

Add featuretools_sql documentation #2262

Merged
merged 52 commits into from
Sep 2, 2022
Merged

Add featuretools_sql documentation #2262

merged 52 commits into from
Sep 2, 2022

Conversation

sbadithe
Copy link
Contributor

@sbadithe sbadithe commented Aug 29, 2022

  • Fixes Integration with SQL? #248
  • This PR adds a guide in the docs/sources/guides folder that describes how to use featuretools_sql with featuretools
  • It updates install.md to reflect the options users have for downloading featuretools_sql. The conda section is unchanged intentionally as we have not yet released featuretools_sql on conda
  • An install test is added to install_test.yaml to check that users can install the add-on
  • A doc is added to the guides section explaining how the user can set up the sql add-on
  • Update the pyproject.toml file to reflect new doc requirements and new complete installation requirements

@codecov
Copy link

codecov bot commented Aug 29, 2022

Codecov Report

Merging #2262 (27ad8ee) into main (e3f2f86) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2262   +/-   ##
=======================================
  Coverage   99.32%   99.32%           
=======================================
  Files         148      148           
  Lines       17706    17706           
=======================================
  Hits        17586    17586           
  Misses        120      120           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@sbadithe sbadithe self-assigned this Aug 29, 2022
@sbadithe sbadithe changed the title Add featuretools_sql documentation [DRAFT] Add featuretools_sql documentation Aug 29, 2022
@gsheni
Copy link
Contributor

gsheni commented Aug 30, 2022

Are we going to need a database instance running now for the docs? Can we use a mock instance instead?

@sbadithe
Copy link
Contributor Author

Are we going to need a database instance running now for the docs? Can we use a mock instance instead?

Just record keeping here: as per discussion in meeting, went with code blocks instead

pyproject.toml Outdated Show resolved Hide resolved
sbadithe and others added 3 commits August 31, 2022 13:23
Co-authored-by: Gaurav Sheni <gvsheni@gmail.com>
README.md Outdated Show resolved Hide resolved
docs/source/install.md Outdated Show resolved Hide resolved
docs/source/install.md Outdated Show resolved Hide resolved
@gsheni gsheni requested a review from ozzieD August 31, 2022 22:18
@sbadithe sbadithe merged commit 601f409 into main Sep 2, 2022
@sbadithe sbadithe deleted the sql-documentation branch September 2, 2022 14:43
@rwedge rwedge mentioned this pull request Oct 6, 2022
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.

Integration with SQL?
3 participants