Skip to content

Add comprehensive API documentation#499

Open
tkoyama010 wants to merge 9 commits intomainfrom
add-api-documentation
Open

Add comprehensive API documentation#499
tkoyama010 wants to merge 9 commits intomainfrom
add-api-documentation

Conversation

@tkoyama010
Copy link
Member

Summary

  • Add detailed API.md with complete reference documentation
  • Document core classes Delaunay2D and Delaunay3D with examples
  • Include functional API documentation for standalone functions
  • Add usage examples and integration guides for PyVista and Shapely
  • Cover performance considerations and best practices

Test plan

  • Review API documentation for accuracy
  • Verify all examples are correct and runnable
  • Check documentation formatting and readability
  • Ensure all public API components are covered

🤖 Generated with Claude Code

- Create detailed API.md with complete reference
- Document core classes Delaunay2D and Delaunay3D
- Include functional API documentation
- Add usage examples and integration guides
- Cover PyVista and Shapely integration
- Include performance considerations and best practices

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 29, 2025
pre-commit-ci bot and others added 8 commits June 29, 2025 13:53
- Remove manual API.md file
- Configure Sphinx with autodoc, autosummary, and napoleon extensions
- Add proper API documentation using docstrings and autodoc
- Create Sphinx templates for classes and functions
- Add comprehensive API reference with autosummary tables
- Improve docstrings for constants and classes
- Generate individual API pages automatically from docstrings
- Support both NumPy and Google docstring styles
- Add intersphinx links to related packages

The documentation now uses the actual docstrings from the source code
instead of manually maintained documentation, ensuring consistency
and reducing maintenance overhead.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Add docstring to DynamicScraper mock class in docs/conf.py
- Remove unused sphinx_gallery import
- Fix whitespace and formatting issues across documentation files
- Ensure all pre-commit hooks pass successfully

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Add missing libgeos-dev package to .readthedocs.yaml apt_packages
- Restore sphinx_gallery import in docs/conf.py for gallery functionality
- Update generated documentation files with proper formatting
- Documentation build now succeeds locally with only minor warnings

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Replace direct sphinx_gallery import with importlib.util.find_spec check
- Fix documentation file formatting issues
- Ensure all pre-commit hooks pass successfully

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
- Fix shapely.geometry.Polygon isinstance() compatibility issue with shapely 2.x
- Add robust error handling for gmsh mesh generation failures
- Fix empty mesh plotting issues in all example gallery scripts
- Convert coordinate lists to proper shapely.Polygon objects in examples
- Add proper exception handling with specific exception types
- Enable pv.global_theme.allow_empty_mesh for demonstration purposes
- Ensure all pre-commit hooks pass successfully

Resolves all 6 failing examples in the RTD gallery build.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
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 this pull request may close these issues.

1 participant