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

Ensure no warnings on docs build #471

Merged
merged 1 commit into from
May 14, 2024
Merged

Conversation

tkknight
Copy link
Contributor

Minor updates to the docs:

  • Force docs build warnings to be errors
  • Force doc build to continue if there are errors
  • Updated an intersphinx mapping
  • Added the :orphan: tag to the release notes file , else it raises a warning (toctree will now ignore this file)

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.16%. Comparing base (0bd6351) to head (9cf0cbf).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #471   +/-   ##
=======================================
  Coverage   89.16%   89.16%           
=======================================
  Files           8        8           
  Lines        2474     2474           
  Branches      418      418           
=======================================
  Hits         2206     2206           
  Misses        170      170           
  Partials       98       98           

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

@tkknight tkknight requested a review from pp-mo May 14, 2024 13:36
Copy link
Member

@pp-mo pp-mo left a comment

Choose a reason for hiding this comment

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

This looks fine. And all useful ideas.

@pp-mo pp-mo merged commit 9c6ae18 into SciTools:main May 14, 2024
10 checks passed
@tkknight tkknight deleted the clean_docs_build branch May 14, 2024 15:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

None yet

3 participants