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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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 to4.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:
What changes were proposed in this pull request?
This PR makes changes to the docs to use
sphinx-design
directivesHow was this patch tested?
Build the docs locally:
Make sure you have the
sphinx-design
branch checked out in theflytekit
,flytesnacks
, andflytectl
repo. Then build the docs in theflyte
repo like so: