Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

use sphinx-design directives instead of sphinx-panels #471

Merged
merged 1 commit into from
Apr 21, 2024

Conversation

cosmicBboy
Copy link
Contributor

@cosmicBboy cosmicBboy commented Apr 19, 2024

Why are the changes needed?

We are currently using sphinx-panels for various documentation elements like dropdowns and tabs. However, sphinx-panels is no longer maintained and is restricting the version of sphinx we use to 4.5.0. The up-to-date solution for this is sphinx-design.

NOTE: We'll have to merge the related PRs in the following order:

  1. use sphinx-design directives instead of sphinx-panels flytekit#2364, Use sphinx design instead of sphinx panels flytesnacks#1652, use sphinx-design directives instead of sphinx-panels #471
  2. Use sphinx design instead of sphinx panels flyte#5254

What changes were proposed in this pull request?

This PR makes changes to the docs to use sphinx-design directives

image

How was this patch tested?

Build the docs locally:

Make sure you have the sphinx-design branch checked out in the flytekit, flytesnacks, and flytectl repo. Then build the docs in the flyte repo like so:

FLYTEKIT_LOCAL_PATH=~/git/flytekit FLYTESNACKS_LOCAL_PATH=~/git/flytesnacks FLYTECTL_LOCAL_PATH=~/git/flytectl make docs

Signed-off-by: cosmicBboy <niels.bantilan@gmail.com>
@cosmicBboy
Copy link
Contributor Author

FYI the Monodocs build test is expected to fail. Will need to merge all of the flyte PR flyteorg/flyte#5254 for this to pass on subsequent PRs to this repo.

@cosmicBboy cosmicBboy merged commit 288215b into master Apr 21, 2024
4 of 5 checks passed
@cosmicBboy cosmicBboy deleted the sphinx-design branch April 21, 2024 05:00
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
3 participants