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

Updates for Flyte docs overhaul #1726

Merged
merged 23 commits into from
Oct 4, 2024
Merged

Updates for Flyte docs overhaul #1726

merged 23 commits into from
Oct 4, 2024

Conversation

neverett
Copy link
Contributor

@neverett neverett commented Sep 3, 2024

This is the flytesnacks component of the Flyte docs overhaul (phase 1). See the related Flyte PR for a full description of this project.

To test these changes, you will need to install the new requirements in docs-requirements.txt (python -m pip install -r docs-requirements.txt) before building locally.

Major changes in this PR

  • Switched to pydata theme
  • Moved tutorials.md and integrations.md into tutorials/index.md and integrations/index.md, respectively
  • Moved deprecated integrations back into this repo from the flyte repo

Signed-off-by: nikki everett <[email protected]>
nikki everett added 13 commits September 5, 2024 16:28
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
…ry captions from tutorials and integrations toctrees

Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
@neverett neverett marked this pull request as ready for review September 30, 2024 17:03
nikki everett added 3 commits September 30, 2024 12:08
Signed-off-by: nikki everett <[email protected]>
Signed-off-by: nikki everett <[email protected]>
@neverett neverett changed the title [WAIT TO MERGE] Update for Flyte docs overhaul Updates for Flyte docs overhaul Sep 30, 2024
ppiegaze
ppiegaze previously approved these changes Oct 3, 2024
@@ -5,7 +5,7 @@
Flyte is designed to be highly extensible and can be customized in multiple ways.

```{note}
Want to contribute an example? Check out the {doc}`Example Contribution Guide <contribute>`.
Want to contribute an example? Check out the [Documentation contribution guide](https://docs.flyte.org/en/latest/flytesnacks/contribute.html).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will be considered an external link as far as sphinx is concerned, and will always go to the latest version of the docs, regardless of version, can we use a ref or preserve the correct doc directive?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call, I'll use a ref for this, since that doc has been moved to the flyte repo as part of the docs overhaul.

@eapolinario eapolinario merged commit caadd26 into master Oct 4, 2024
57 of 58 checks passed
@eapolinario eapolinario deleted the nikki/docs/refresh branch October 4, 2024 18:23
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.

4 participants