Flyte docs overhaul (phase 1)

[neverett]

Tracking issue

This is phase 1 in a multi-phase project to overhaul the Flyte docs to make them easier to maintain and contribute to, and more useful and usable for readers.

To test these changes locally, you will need to do the following:

• Update your monodocs conda environment with the new monodocs-environment.lock.yaml file: conda env update --file monodocs-environment.lock.yaml
• Clone flytesnacks and check out the nikki/docs/refresh branch
• Set the FLYTESNACKS_LOCAL_PATH environment variable to the location of your local copy of flytesnacks

Note: The monodocs build will fail for this PR until the linked flytesnacks PR is merged.

Why are the changes needed?

These changes make the Flyte docs easier to maintain and contribute to and lay the groundwork for phase 2 of the Flyte docs overhaul project, in which we'll significantly update the content itself to be more useful, usable, and accurate for readers. They also bring the Flyte docs into closer alignment with Union docs by switching the theme from furo to pydata.

What changes were proposed in this pull request?

• Switch to pydata theme. This meant reorganizing docs subdirectories and updating templates, among other changes.
• Use the Algolia Docsearch extension and environment variables instead of putting the Algolia API key in a JS file and requiring custom HTML and CSS to render the search box.
• Update the flytesnacks and flyte docs contribution guides.

Note: I removed the old version switcher, since it was part of the old theme. I will add the pydata-specific version switcher in phase 2. (The current version switcher is only partially usable at the moment -- the links are only visible in dark mode, and dark mode is not available in Chrome or Safari -- so although this is a regression, it's not a major one.)

Screenshots from local build

Landing page

User guide section

How was this patch tested?

Tested locally.

Check all the applicable boxes

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

Related PRs

flyteorg/flytesnacks#1726

Docs link

https://flyte--5772.org.readthedocs.build/en/5772/ (Tutorials and integrations will not appear in this build, because we're pulling from flytesnacks master, not the flytesnacks docs overhaul branch.)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 36.31%. Comparing base (881d7a2) to head (10d45f6).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #5772   +/-   ##
=======================================
  Coverage   36.31%   36.31%           
=======================================
  Files        1304     1304           
  Lines      110072   110072           
=======================================
  Hits        39974    39974           
  Misses      65936    65936           
  Partials     4162     4162           

Flag	Coverage Δ
unittests-datacatalog	51.37% <ø> (ø)
unittests-flyteadmin	55.60% <ø> (ø)
unittests-flytecopilot	12.17% <ø> (ø)
unittests-flytectl	62.21% <ø> (ø)
unittests-flyteidl	7.12% <ø> (ø)
unittests-flyteplugins	53.35% <ø> (ø)
unittests-flytepropeller	41.91% <ø> (ø)
unittests-flytestdlib	55.37% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[ppiegaze]

This look great!

I know that this version is not meant to address every formatting or content problem but there are a few things I think we should fix before we roll this out:

• Section title "API reference" -> "Flytekit API"
• Can we make it go directly to the Flytekit API page when the top nav item is clicked? Currently it goes to an empty page where you have to make one more click to go to the Flytekit API page
• The title "FlyteIDL API Reference" should be shortened to "FlyteIDL API"
• "Deployment Guide" -> "Deployment guide"
• The "Section Navigation" headings above the left nav should be the same as the top level nav titles