mdabrowski1990 / uds

Python package for communication via UDS (Unified Diagnostic Services) protocol. The package supports typical buses (i.e. CAN, Ethernet, LIN, FlexRay, K-Line) with possible extensions to any bus.

https://uds.readthedocs.io/

MIT License

82 stars 12 forks source link

[INVESTIGATE] Add doc8 as sphinx documentation checker #250

Closed mdabrowski1990 closed 5 months ago

mdabrowski1990 commented 11 months ago

Description

As a developer, I would love to have automated checks for sphinx documentation.

Testing

CI/CD is passing

Acceptance Criteria

investigate whether doc8 can be added to existing CI/CD
[optional] add doc8 checks to CI/CD workflows
- rework documentation to pass these checks