feat: Setup MkDocs with Material theme for documentation #54
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
- Added mkdocs, mkdocs-material, mkdocstrings, and mkdocstrings-python as dev dependencies. - Created mkdocs.yml configuration for the Material theme and mkdocstrings plugin. - Initialized the docs/ directory with index.md and api.md. - Added omspy.order module to the API documentation. - Fixed a syntax error in omspy/order.py that was preventing mkdocstrings from collecting docs. - Added `validate_assignment = True` to Order model's Pydantic Config. Note: Tests in `tests/test_order.py` are currently failing due to the `validate_assignment = True` change and will need to be updated separately to ensure mocks return string order_ids.
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.
validate_assignment = Trueto Order model's Pydantic Config.Note: Tests in
tests/test_order.pyare currently failing due to thevalidate_assignment = Truechange and will need to be updated separately to ensure mocks return string order_ids.