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

DOC-648 Add pages for Neptune and W&B plugins #2803

Merged
merged 3 commits into from
Oct 14, 2024

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Oct 10, 2024

Why are the changes needed?

Adds docs pages for Neptune and W&B plugins.

This is one of three PRs we need to merge in the following order to get the neptune and wandb flytekit plugin docs onto the docs site:

  1. flytesnacks PR to fix refs in neptune and wandb plugin docs
  2. flyte PR to update monodocs dependencies
  3. flytekit PR (this one) to add new flytekit plugin docs for neptune and wandb plugins (after re-running monodocs build)

Check all the applicable boxes

  • I updated the documentation accordingly.
  • All new and existing tests passed.
  • All commits are signed-off.

Signed-off-by: nikki everett <nikki@union.ai>
@neverett
Copy link
Contributor Author

Seeing the following monodocs build error:

 sphinx.errors.SphinxWarning: Failed to import flytekitplugins.neptune.
Possible hints:
* AttributeError: module 'flytekitplugins' has no attribute 'neptune'
* ModuleNotFoundError: No module named 'neptune'

/cc @thomasjpfan @cosmicBboy

@neverett neverett self-assigned this Oct 10, 2024
Copy link

codecov bot commented Oct 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.45%. Comparing base (cd8216a) to head (3c1ea46).
Report is 12 commits behind head on master.

Additional details and impacted files
@@             Coverage Diff             @@
##           master    #2803       +/-   ##
===========================================
+ Coverage   76.82%   94.45%   +17.63%     
===========================================
  Files         196       24      -172     
  Lines       20301      794    -19507     
  Branches     2610        0     -2610     
===========================================
- Hits        15596      750    -14846     
+ Misses       4004       44     -3960     
+ Partials      701        0      -701     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@cosmicBboy
Copy link
Contributor

Do we need to update docs requirements to fix docs build error?

@neverett
Copy link
Contributor Author

Do we need to update docs requirements to fix docs build error?

Yeah, we can try that -- the current docs requirements file doesn't list every plugin, only flytekitplugins-deck-standard, flytekitplugins-kfpytorch, and flytekitplugins-sqlalchemy, although it does list a lot of plugin dependencies.

nikki everett added 2 commits October 11, 2024 12:00
Signed-off-by: nikki everett <nikki@union.ai>
Signed-off-by: nikki everett <nikki@union.ai>
@neverett
Copy link
Contributor Author

neverett commented Oct 11, 2024

After testing locally, it looks like we need to add wandb and neptune to the monodocs requirements -- will open a flyte PR shortly.

@neverett neverett merged commit 48d1841 into master Oct 14, 2024
106 checks passed
@neverett neverett deleted the nikki/docs/update-plugin-docs branch October 14, 2024 15:57
otarabai pushed a commit to otarabai/flytekit that referenced this pull request Oct 15, 2024
* add pages for neptune and wandb plugins

Signed-off-by: nikki everett <nikki@union.ai>

* add autosummary sections to init files

Signed-off-by: nikki everett <nikki@union.ai>

* don't render the TOC twice

Signed-off-by: nikki everett <nikki@union.ai>

---------

Signed-off-by: nikki everett <nikki@union.ai>
kumare3 pushed a commit that referenced this pull request Nov 8, 2024
* add pages for neptune and wandb plugins

Signed-off-by: nikki everett <nikki@union.ai>

* add autosummary sections to init files

Signed-off-by: nikki everett <nikki@union.ai>

* don't render the TOC twice

Signed-off-by: nikki everett <nikki@union.ai>

---------

Signed-off-by: nikki everett <nikki@union.ai>
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.

2 participants