Skip to content

Fixing docs warnings and docstring updates - #45

Open
wathen wants to merge 1 commit into
mainfrom
41-docs_errors
Open

Fixing docs warnings and docstring updates#45
wathen wants to merge 1 commit into
mainfrom
41-docs_errors

Conversation

@wathen

@wathen wathen commented Aug 25, 2026

Copy link
Copy Markdown
Member

Summary

Made the documentation build warning-free and aligned warning policy across build environments.

  • Fixed remaining Sphinx/docutils/MyST warnings in API docs and cookbook documentation.
  • Removed broad warning suppression from conf.py.
  • Enabled Google-style docstring parsing with Napoleon.
  • Set Read the Docs to fail on warnings.
  • Disabled TODO output in published docs and removed visible placeholder TODOs.
  • Verified all cookbook pages, notebooks, images, and local links are present in the built docs.

Related issue

Closes #41


Type of change

Select all that apply:

  • [ x] Bug fix
  • New feature
  • Code port
  • Refactor
  • [ x] Documentation update
  • Test update
  • [x ] Build / CI change
  • Other: <describe>

@wathen
wathen requested a review from danclewley August 25, 2026 13:53
@wathen wathen mentioned this pull request Aug 26, 2026
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Doc build errors

1 participant