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 update #318

Merged
merged 5 commits into from Nov 3, 2023
Merged

Documentation update #318

merged 5 commits into from Nov 3, 2023

Conversation

ianthomas23
Copy link
Member

Updates to documentation:

  • Split the top-level API docs into 4 pages: enums, contour_generator, ContourGenerator, other.
  • Add pages on manipulating contoured data (convert_* and dechunk_* functions).
  • Fix Renderer-derived __init__ docstrings.
  • Add new section on using with external libraries starting with Shapely.
  • Clarify that can use strings instead of enums in some places.
  • Clarify use of -np.inf and np.inf for filled contours.

@ianthomas23 ianthomas23 merged commit 736b0ac into contourpy:main Nov 3, 2023
30 checks passed
@ianthomas23 ianthomas23 deleted the doc_update branch November 3, 2023 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant