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

update doc dependencies, use furo theme #2507

Merged
merged 4 commits into from
Aug 14, 2024
Merged

update doc dependencies, use furo theme #2507

merged 4 commits into from
Aug 14, 2024

Conversation

ITProKyle
Copy link
Collaborator

@ITProKyle ITProKyle commented Aug 14, 2024

Summary

Update Sphinx to the latest version we are able to given the python version requirement.
Replace sphinx_rtd_theme with furo, a dynamic theme supporting a light and dark mode used for some official python documentation.

Why This Is Needed

Improved stability for building Runway's documentation and to provide a more modern look.

What Changed

Added

  • added furo to the docs dependency group
  • added sphinx-copybutton to the docs dependency group
  • added sphinx-design to the docs dependency group
    • replaces sphinx-tabs
  • added sphinx-notfound-page to the docs dependency group
  • added sphinxcontrib-external-links to the docs dependency group
  • added sphinxcontrib-jquery to the docs dependency group
    • used by a new JS script that causes external links to be opened in new browser windows

Changed

  • updated docs dependency group

@ITProKyle ITProKyle added the documentation Improvements or additions to documentation label Aug 14, 2024
@ITProKyle ITProKyle self-assigned this Aug 14, 2024
@github-actions github-actions bot added github_actions Update to GitHub Actions javascript Pull request that updates Javascript code poetry Update to Poetry configuration python Update to Python code labels Aug 14, 2024
for some reason, it got disabled
Copy link

codecov bot commented Aug 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.16%. Comparing base (26e72a7) to head (5b87182).
Report is 1 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2507   +/-   ##
=======================================
  Coverage   90.16%   90.16%           
=======================================
  Files         247      247           
  Lines       15610    15610           
=======================================
  Hits        14074    14074           
  Misses       1536     1536           

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 26e72a7...5b87182. Read the comment docs.

@ITProKyle ITProKyle marked this pull request as ready for review August 14, 2024 15:18
Copy link

@alexander-kogan alexander-kogan left a comment

Choose a reason for hiding this comment

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

LGTM

@ITProKyle ITProKyle merged commit 3beabc3 into master Aug 14, 2024
24 checks passed
@ITProKyle ITProKyle deleted the docs/furo branch August 14, 2024 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation github_actions Update to GitHub Actions javascript Pull request that updates Javascript code poetry Update to Poetry configuration python Update to Python code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants