docs: Start building docs #33
Closed
Conversation
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
Closed
tysoncung
added a commit
to tysoncung/backoff
that referenced
this pull request
Oct 29, 2025
- Enhanced mkdocs.yml with structured navigation - Created complete documentation structure: - Getting started guide with examples - User guide covering decorators, wait strategies, configuration, event handlers, logging, and async - Advanced topics: combining decorators, runtime config, custom strategies - Comprehensive examples for real-world use cases - FAQ with common questions and troubleshooting - API reference with mkdocstrings integration - Added GitHub Actions workflow for automatic deployment to GitHub Pages - Builds upon PR python-backoff#33 with full content implementation This provides production-ready documentation for the backoff library.
6 tasks
edgarrmondragon
added a commit
that referenced
this pull request
Oct 29, 2025
* docs: Start building docs * docs: Add comprehensive MkDocs documentation - Enhanced mkdocs.yml with structured navigation - Created complete documentation structure: - Getting started guide with examples - User guide covering decorators, wait strategies, configuration, event handlers, logging, and async - Advanced topics: combining decorators, runtime config, custom strategies - Comprehensive examples for real-world use cases - FAQ with common questions and troubleshooting - API reference with mkdocstrings integration - Added GitHub Actions workflow for automatic deployment to GitHub Pages - Builds upon PR #33 with full content implementation This provides production-ready documentation for the backoff library. * Pin actions * Use locked dependencies * Update changelog --------- Co-authored-by: Edgar Ramírez Mondragón <[email protected]>
Author
|
Superseded by #39 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Related