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

Add explicit Sphinx configuration for readthedocs #324

Merged
merged 1 commit into from
Jan 15, 2025

Conversation

douglatornell
Copy link
Member

Updated .readthedocs.yaml to define Sphinx builder settings, including the
builder type, configuration file path, and fail_on_warning option. This is
necessary due to readthedocs deprecating projects without explicit builder
configuration that comes into effect on 20-Jan-2025.

    Updated `.readthedocs.yaml` to define Sphinx builder settings, including the
    builder type, configuration file path, and `fail_on_warning` option. This is
    necessary due to readthedocs deprecating projects without explicit builder
    configuration that comes into effect on 20-Jan-2025.
@douglatornell douglatornell added bug Something isn't working documentation Improvements or additions to documentation maintenance Codebase maintenance labels Jan 15, 2025
@douglatornell douglatornell added this to the v25.1 milestone Jan 15, 2025
@douglatornell douglatornell merged commit be1313f into main Jan 15, 2025
7 checks passed
@douglatornell douglatornell deleted the rtd-sphinx-config branch January 15, 2025 19:44
Copy link

codecov bot commented Jan 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.72%. Comparing base (ece70cb) to head (86ffece).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #324   +/-   ##
=======================================
  Coverage   77.72%   77.72%           
=======================================
  Files         132      132           
  Lines       18777    18777           
  Branches      762      762           
=======================================
  Hits        14595    14595           
  Misses       4116     4116           
  Partials       66       66           
Flag Coverage Δ
unittests 77.72% <ø> (ø)

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation maintenance Codebase maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant