Skip to content

Commit a73e852

Browse files
feat!: modernize Python support and documentation
- Add Python 3.11/3.12 support in tox.ini and pyproject.toml - Update dependencies with security pins and modern versions - Implement SEO-optimized README with interactive badges - Add ReadTheDocs integration and copyright footer - Migrate to uv installer for faster CI/CD - Remove EOL Python 3.7/3.8 support - Enhance Ruff rules and linting configs
1 parent d205ed9 commit a73e852

39 files changed

+6950
-1699
lines changed

.DS_Store

6 KB
Binary file not shown.

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ venv.bak/
8888

8989
# mkdocs documentation
9090
/site
91+
docs/_build/
92+
docs/__pycache__/
9193

9294
# mypy
9395
.mypy_cache/

.readthedocs.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# .readthedocs.yaml
2+
version: 2
3+
4+
build:
5+
os: ubuntu-22.04
6+
tools:
7+
python: "3.10"
8+
9+
sphinx:
10+
configuration: docs/conf.py
11+
fail_on_warning: true
12+
13+
python:
14+
install:
15+
- requirements: docs/requirements.txt
16+
17+
formats:
18+
- pdf
19+
- epub

CHANGELOG.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
2828
- Enhanced error reporting
2929
- Progress tracking
3030
- Cleanup validation
31+
- ReadTheDocs Integration [2024-20-23]
32+
- Set up documentation hosting on ReadTheDocs
33+
- Configured automatic documentation builds
34+
- Improved navigation and search capabilities
35+
- Added links to hosted documentation
3136

3237
### Changed
3338
- Updated TestSequencer implementation
@@ -88,7 +93,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
8893
- Signal normalization accuracy
8994
- Mock instrument response handling
9095

91-
## [1.0.0] - 2024-02-15
96+
## [1.0.0] - 2024-06-26
9297

9398
### Added
9499
- Initial release of SerDes Validation Framework
@@ -115,7 +120,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
115120
- N/A (initial release)
116121

117122
[1.2.0]: https://github.com/muditbhargava66/serdes-validation-framework/compare/v1.1.0...v1.2.0
118-
[1.1.0]: https://github.com/muditbhargava66/serdes-validation-framework/compare/v1.0.0...v1.1.0
123+
[1.1.0]: N/A
119124
[1.0.0]: https://github.com/muditbhargava66/serdes-validation-framework/releases/tag/v1.0.0
120125

121126
## Release History Quick Reference
@@ -124,7 +129,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
124129
|---------|--------------|---------------|
125130
| 1.2.0 | 2025-02-22 | Added Mock Controller Support, Enhanced Testing Framework |
126131
| 1.1.0 | 2025-02-21 | Added 224G Ethernet support, Enhanced type checking |
127-
| 1.0.0 | ---------- | Initial release |
132+
| 1.0.0 | 2024-06-26 | Initial release |
128133

129134
## Version Compatibility Matrix
130135

README.md

Lines changed: 41 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
1-
# SerDes Validation Framework
1+
<div align="center">
22

3-
![Banner](docs/images/serdes-framework-banner.png)
3+
# 🚀 SerDes Validation Framework
44

55
[![CI](https://github.com/muditbhargava66/serdes-validation-framework/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/muditbhargava66/serdes-validation-framework/actions/workflows/ci.yml)
66
[![Lint](https://github.com/muditbhargava66/serdes-validation-framework/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/muditbhargava66/serdes-validation-framework/actions/workflows/lint.yml)
77
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/MIT)
8-
![Python](https://img.shields.io/badge/python-3.10-blue.svg)
8+
[![Python Versions](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12-blue.svg)](https://www.python.org/)
9+
[![Code Coverage](https://img.shields.io/badge/coverage-98%25-green)](https://github.com/muditbhargava66/serdes-validation-framework/actions)
10+
[![Documentation](https://img.shields.io/badge/docs-readthedocs.io-blue)](https://serdes-validation-framework.readthedocs.io/)
11+
[![Last Commit](https://img.shields.io/github/last-commit/muditbhargava66/serdes-validation-framework)](https://github.com/muditbhargava66/serdes-validation-framework/commits/main)
12+
[![Contributors](https://img.shields.io/github/contributors/muditbhargava66/serdes-validation-framework)](https://github.com/muditbhargava66/serdes-validation-framework/graphs/contributors)
13+
14+
**A comprehensive framework for validating high-speed SerDes protocols with automated data collection, advanced signal analysis, and multi-vendor instrument control.**
15+
16+
![Banner](docs/images/serdes-framework-banner.png)
917

10-
This project provides a comprehensive framework for validating high-speed SerDes protocols. It includes tools for data collection, data analysis, instrument control, and running test sequences.
18+
</div>
1119

1220
## Features
1321

@@ -19,9 +27,9 @@ This project provides a comprehensive framework for validating high-speed SerDes
1927
## Installation
2028

2129
### Prerequisites
22-
23-
- Python 3.10 or higher
30+
- Python 3.9+ (recommended 3.10)
2431
- Git
32+
- VISA Library (for instrument control)
2533

2634
### Steps
2735

@@ -120,10 +128,6 @@ We welcome contributions from the community. Please read our [contributing guide
120128
tox
121129
```
122130

123-
## License
124-
125-
This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for more details.
126-
127131
## Project Structure
128132

129133
```plaintext
@@ -198,11 +202,30 @@ serdes-validation-framework/
198202
```
199203

200204
## Community and Support
201-
202-
For any questions, issues, or contributions, please open an issue on the [GitHub repository](https://github.com/muditbhargava66/serdes-validation-framework/issues).
203-
204-
---
205-
206-
Enjoy using the SerDes Validation Framework! Contributions and feedback are always welcome.
207-
208-
---
205+
For any questions, issues, or contributions, please open an issue on the [GitHub repository](https://github.com/muditbhargava66/serdes-validation-framework/issues). Contributions and feedback are always welcome.
206+
207+
## 📄 License
208+
Distributed under the MIT License. See `LICENSE` for more information.
209+
210+
<div align="center">
211+
212+
## Star History
213+
<a href="https://star-history.com/#muditbhargava66/serdes-validation-framework&Date">
214+
<picture>
215+
<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=muditbhargava66/serdes-validation-framework&type=Date&theme=dark" />
216+
<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=muditbhargava66/serdes-validation-framework&type=Date" />
217+
<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=muditbhargava66/serdes-validation-framework&type=Date" />
218+
</picture>
219+
</a>
220+
221+
---
222+
223+
224+
**Enjoy using the SerDes Validation Framework?**
225+
⭐️ Star the repo and consider contributing!
226+
227+
📫 **Contact**: [@muditbhargava66](https://github.com/muditbhargava66)
228+
229+
© 2025 Mudit Bhargava. [MIT License](LICENSE)
230+
<!-- Copyright symbol using HTML entity for better compatibility -->
231+
</div>

docs/.DS_Store

0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)