Skip to content

Commit

Permalink
Improved documentation to have an overview page (#23)
Browse files Browse the repository at this point in the history
* Add diagrams

* Add overview documentation

* Add missing rye run commands

* Update pyproject dev dependency to use material extension

* Update theme & add overview page

* Add another pros for aioclock compared to rocketry
  • Loading branch information
ManiMozaffar authored Aug 15, 2024
1 parent 04dece1 commit 39919e8
Show file tree
Hide file tree
Showing 10 changed files with 4,952 additions and 12 deletions.
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ test: ## Test the code with pytest
.PHONY: docs
docs: ## Build and serve the documentation
@echo "🚀 Testing documentation: Building and testing"
mkdocs serve
rye run mkdocs serve

.PHONY: deploy-docs
deploy-docs: ## Build and serve the documentation
@echo "🚀 Deploying documentation"
python deploy_docs.py
rye run python deploy_docs.py


.PHONY: docs-test
Expand Down
1 change: 1 addition & 0 deletions docs/alternative.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Rocketry is a modern statement-based scheduling framework for Python. It is simp

When **AioClock** might be a better choice:

- You don't want to be dependent to other unnecessary libraries like [redbird](https://github.com/Miksus/red-bird)
- You need a truly light weight solution.
- You are using Pydantic v2.
- Type safety is important to you. All triggers are type safe, but some statements are stringly typed in rocketry.
Expand Down
Loading

0 comments on commit 39919e8

Please sign in to comment.