Remove WIP warning and fix PyPI badge on GitHub#12
Merged
Conversation
- Remove "work in progress" warning from docs homepage - Replace badge.fury.io badge with shields.io for PyPI version (badge.fury.io doesn't render on GitHub due to referrer policy) https://claude.ai/code/session_012eUQJKwLLveY4fc57kZcGw
- Document OutputFormat and CompressionType enums in API reference - Update write() method signature with format/compression parameters - Add "Compressed Output" section to quickstart guide with examples - Document available compression types and their requirements https://claude.ai/code/session_012eUQJKwLLveY4fc57kZcGw
- Document add_custom_note, add_metadata, add_annotations methods - Add CustomNote and CustomNoteType documentation - Configure Sphinx autodoc with package path and napoleon settings - Create api-reference.md with auto-generated docs from docstrings - Add api-reference to table of contents The autodoc setup allows documentation to be generated directly from source code docstrings, helping keep docs in sync with implementation. https://claude.ai/code/session_012eUQJKwLLveY4fc57kZcGw
Removes duplicate documentation in favor of the auto-generated API reference. This ensures documentation stays in sync with code changes since it's generated directly from docstrings. https://claude.ai/code/session_012eUQJKwLLveY4fc57kZcGw
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #12 +/- ##
========================================
Coverage 92.60% 92.60%
========================================
Files 5 5
Lines 757 757
========================================
Hits 701 701
Misses 56 56 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
(badge.fury.io doesn't render on GitHub due to referrer policy)
https://claude.ai/code/session_012eUQJKwLLveY4fc57kZcGw