Skip to content

Conversation

@xylar
Copy link
Collaborator

@xylar xylar commented Nov 28, 2025

This pull request introduces improvements to the documentation build process, enhances the clarity and formatting of the documentation, and updates some docstrings and configuration. The main focus is on making documentation builds stricter (treating warnings as errors), improving Sphinx configuration, and refining the documentation for better usability and consistency.

@xylar xylar self-assigned this Nov 28, 2025
@xylar xylar added conda package documentation ci Changes that affect github actions CI labels Nov 28, 2025
@xylar xylar requested a review from Copilot November 28, 2025 15:15
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR improves the documentation build process and enhances documentation quality by making builds stricter (treating warnings as errors), fixing formatting inconsistencies, and improving docstring clarity. The changes ensure better documentation maintainability and consistency across the project.

Key Changes:

  • Implemented WERROR flag in Makefile to treat Sphinx warnings as errors during documentation builds, enabled in CI
  • Fixed reStructuredText formatting issues including reference label positioning, note block indentation, and duplicate lines
  • Improved docstring formatting in Python code and fixed Sphinx autosummary method references

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
conda_package/mpas_tools/viz/mpas_to_xdmf/mpas_to_xdmf.py Improved docstring formatting with proper reStructuredText syntax for lists and code literals
conda_package/docs/releasing.rst Converted Markdown link to reStructuredText format and improved spacing
conda_package/docs/mpas_to_xdmf.rst Fixed note block indentation for proper rendering
conda_package/docs/mesh_creation.rst Moved reference label after unicode directive following reStructuredText best practices
conda_package/docs/mesh_conversion.rst Removed duplicate line and added command help text example
conda_package/docs/interpolation.rst Moved reference label after unicode directive following reStructuredText best practices
conda_package/docs/conf.py Updated intersphinx Python docs URL to Python 3 specific version
conda_package/docs/api.rst Added reference label and fixed method references (removed parentheses)
conda_package/docs/Makefile Implemented WERROR flag mechanism to optionally treat Sphinx warnings as errors
.github/workflows/build_workflow.yml Enabled WERROR flag in CI documentation builds

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@xylar xylar force-pushed the fix-docs branch 8 times, most recently from e33ddaa to 337af6b Compare November 28, 2025 20:20
@xylar xylar merged commit 07003b8 into MPAS-Dev:master Nov 28, 2025
6 checks passed
@xylar xylar deleted the fix-docs branch November 28, 2025 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci Changes that affect github actions CI conda package documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant