Add comprehensive documentation with mkdocs-material and GitHub Pages deployment#5
Merged
Merged
Conversation
… deployment Documentation Structure: - Getting Started: Installation, Quick Start, Authentication - User Guide: Client, Pools, Partners, Distributions, Certificates, History - API Reference: Client, Models, Resources, Exceptions - Contributing: Development Setup, Testing, Code Style - Changelog Features: - mkdocs-material theme with dark/light mode - mike for multi-version documentation - GitHub Actions workflow for automatic deployment - Deploys to GitHub Pages on push to main/staging/develop - Version tagging support (v*) - Comprehensive code examples matching actual API - Search functionality and navigation tabs Dependencies Added: - mkdocs>=1.6.0 - mkdocs-material>=9.6.0 - mike>=2.1.0 Deployment: - main branch → latest + stable aliases - staging branch → staging version - develop branch → dev version - version tags → versioned deployment - Auto-deploys to https://inntran.github.io/tmo-api-python/ API Documentation: - Uses TMOClient and TMOException naming - Documents actual token/database parameters - Shows shares_pools/capital_pools structure - Includes all resource types and methods 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
inntran
changed the title
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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
1 participant
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.
Documentation Structure:
Features:
Dependencies Added:
Deployment:
API Documentation:
🤖 Generated with Claude Code