Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation for python can transport interface #241

Merged
merged 24 commits into from Nov 2, 2023

Conversation

mdabrowski1990
Copy link
Owner

@mdabrowski1990 mdabrowski1990 commented Oct 31, 2023

Description

  • provide user guide for CAN Transport Interface
  • add code examples
  • update current status of implemented features
  • extend page with installation documentation
  • add python 3.12 to both documentation and testing
  • adjust configuration of ReadTheDocs

How Has This Been Tested?

  • CI execution
  • documentation was successfully build on ReadTheDocs portal

Process

I know the process and did my best to follow it

Move examples to different directory (change structure of examples)
Add examples page to documentation.
- update CAN Segmenter functionality documentation
- leave TODO marks in sections to update
adjust readthedocs configuration so it builds again
fix to make a test build
try to solve graphviz issue
try to fix graphviz issue
hopefully sudo is avaialble although I doubt that =/
seems like I found a fix for graphviz issue
Update tables with implementation statuses.
add development version installation command
- include code in examples section
- rework installation page
- adjust current status of features
- provide user guide for python-can transport interface
-
add link to knowledge base
@mdabrowski1990 mdabrowski1990 added documentation Improvements or additions to documentation CAN Related to CAN specific implementation labels Oct 31, 2023
@mdabrowski1990 mdabrowski1990 self-assigned this Oct 31, 2023
@mdabrowski1990 mdabrowski1990 added this to In progress in UDS via automation Oct 31, 2023
@mdabrowski1990 mdabrowski1990 linked an issue Oct 31, 2023 that may be closed by this pull request
Remove python 3.12 from static code analysis as it is not stable at the moment
Copy link

codecov bot commented Oct 31, 2023

Codecov Report

Merging #241 (c88c178) into main (2def9d3) will not change coverage.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff            @@
##              main      #241   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           39        39           
  Lines         2346      2346           
=========================================
  Hits          2346      2346           
Flag Coverage Δ
integration-tests 87.97% <100.00%> (ø)
unit-tests 100.00% <100.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
uds/__init__.py 100.00% <100.00%> (ø)
uds/can/abstract_addressing_information.py 100.00% <100.00%> (ø)
uds/segmentation/can_segmenter.py 100.00% <100.00%> (ø)
uds/transport_interface/can_transport_interface.py 100.00% <ø> (ø)

mdabrowski1990 and others added 5 commits October 31, 2023 15:22
test if graphviz extension needs to be specified
adjust link to readthedocs
update functionalities tables
fix minor mistakes
Copy link
Owner Author

@mdabrowski1990 mdabrowski1990 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Add link to documentation
@mdabrowski1990 mdabrowski1990 merged commit 2f7bd84 into main Nov 2, 2023
54 checks passed
UDS automation moved this from In progress to Done Nov 2, 2023
@mdabrowski1990 mdabrowski1990 deleted the documentation-for-python-can-transport-interface branch November 2, 2023 21:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CAN Related to CAN specific implementation documentation Improvements or additions to documentation
Projects
No open projects
UDS
  
Done
Development

Successfully merging this pull request may close these issues.

Prepare user documentation for Transport Interface (python-can)
2 participants