Skip to content

Conversation

NFUChen
Copy link
Contributor

@NFUChen NFUChen commented Jun 17, 2025

Add PySpring Scheduler Documentation

Description

This PR adds comprehensive documentation for the PySpring Scheduler feature, which provides a robust and flexible way to manage scheduled tasks in PySpring applications. The documentation covers installation, configuration, usage patterns, and best practices.

Changes

  • Added new documentation file docs/guide/scheduling/scheduler.md
  • Updated mkdocs.yml to include the new scheduler documentation in the navigation

Documentation Coverage

The new documentation includes:

  • Installation instructions
  • Overview of the scheduler's capabilities
  • Configuration options and setup
  • Usage examples with different trigger types (Interval, Cron)
  • Component-based scheduling with dependency injection
  • Best practices for resource management and error handling
  • Common use cases and troubleshooting guide

Testing

  • Documentation builds successfully with MkDocs
  • All code examples are properly formatted
  • Navigation structure is correct

Related Issues

[Add any related issue numbers here]

Additional Notes

The scheduler documentation is based on the current implementation of the PySpring Scheduler package, which is built on top of APScheduler and integrates with PySpring's dependency injection system.

- Introduced a new guide on the PySpring Scheduler, detailing installation, configuration, and usage of scheduled tasks with decorators.
- Updated `mkdocs.yml` to include the new Scheduling section in the documentation navigation.
- Updated import statements in the scheduling guide to reflect the correct module name `py_spring_scheduler` instead of `pyspring_scheduler` for consistency and accuracy.
- Changed the installation command to reflect that the package can only be installed directly from the git repository due to active development.
@NFUChen NFUChen changed the title Docs/scheduler Add PySpring Scheduler Documentation Jun 17, 2025
@NFUChen NFUChen merged commit cf8bf12 into main Jun 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants