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 #87

Merged
merged 1 commit into from
Jan 19, 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 Package or repo maintenance labels Jan 19, 2025
@douglatornell douglatornell added this to the v25.1 milestone Jan 19, 2025
Copy link

codecov bot commented Jan 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.57%. Comparing base (ef08217) to head (92940bf).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #87   +/-   ##
=======================================
  Coverage   95.57%   95.57%           
=======================================
  Files           9        9           
  Lines        1400     1400           
  Branches       79       79           
=======================================
  Hits         1338     1338           
  Misses         57       57           
  Partials        5        5           
Flag Coverage Δ
unittests 95.57% <ø> (ø)

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.

@douglatornell douglatornell merged commit 20cb76c into main Jan 19, 2025
11 checks passed
@douglatornell douglatornell deleted the rtd-sphinx-config branch January 19, 2025 20:08
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 Package or repo maintenance
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant