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

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

Merged
merged 3 commits into from
Apr 21, 2024
Merged

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 #2364, Use sphinx design instead of sphinx panels flytesnacks#1652, use sphinx-design directives instead of sphinx-panels flytectl#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
  • Cleans up API docs to leverage the upgraded furo version that displays the right sidebar
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

@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Apr 19, 2024
@cosmicBboy cosmicBboy changed the title https://github.com/flyteorg/flyte/pull/5254 use sphinx-design directives instead of sphinx-panels Apr 19, 2024
@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.

@dosubot dosubot bot added the lgtm This PR has been approved by maintainer label Apr 20, 2024
@cosmicBboy cosmicBboy merged commit 9d94c83 into master Apr 21, 2024
47 of 48 checks passed
@cosmicBboy cosmicBboy deleted the sphinx-design branch April 21, 2024 19:49
fiedlerNr9 pushed a commit that referenced this pull request Jul 25, 2024
* update docs to use sphinx design, custom rst template

Signed-off-by: cosmicBboy <[email protected]>

* fix docstring formatting

Signed-off-by: cosmicBboy <[email protected]>

* update autosummary for accelerators

Signed-off-by: cosmicBboy <[email protected]>

---------

Signed-off-by: cosmicBboy <[email protected]>
Signed-off-by: Jan Fiedler <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm This PR has been approved by maintainer size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants