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

Documentation build on CircleCI is failing #2479

Closed
bouweandela opened this issue Jul 16, 2024 · 0 comments · Fixed by #2480
Closed

Documentation build on CircleCI is failing #2479

bouweandela opened this issue Jul 16, 2024 · 0 comments · Fixed by #2480
Labels
documentation Improvements or additions to documentation

Comments

@bouweandela
Copy link
Member

bouweandela commented Jul 16, 2024

The documentation build is failing with the new version of sphinx because it emits a long list of warnings, see below for the first few warnings. I couldn't find in the sphinx autosummary documentation how to solve this.

Related issue: sphinx-doc/sphinx#12589.

WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CheckLevels' with 'CheckLevels'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CMORCheck' with 'CMORCheck'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CMORCheckError' with 'CMORCheckError'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.cmor_check_metadata' with 'cmor_check_metadata'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.cmor_check_data' with 'cmor_check_data'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.cmor_check' with 'cmor_check'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CheckLevels.DEBUG' with 'DEBUG'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CheckLevels.DEBUG' with 'CheckLevels.DEBUG'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CheckLevels.STRICT' with 'STRICT'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CheckLevels.STRICT' with 'CheckLevels.STRICT'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CheckLevels.DEFAULT' with 'DEFAULT'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CheckLevels.DEFAULT' with 'CheckLevels.DEFAULT'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CheckLevels.RELAXED' with 'RELAXED'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CheckLevels.RELAXED' with 'CheckLevels.RELAXED'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CheckLevels.IGNORE' with 'IGNORE'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CheckLevels.IGNORE' with 'CheckLevels.IGNORE'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CMORCheck.check_metadata' with 'check_metadata'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CMORCheck.check_metadata' with 'CMORCheck.check_metadata'.
WARNING: Summarised items should not include the current module. Replace 'esmvalcore.cmor.check.CMORCheck.check_data' with 'check_data'.
...
@bouweandela bouweandela added the documentation Improvements or additions to documentation label Jul 16, 2024
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
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant