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

Prepare user documentation for Transport Interface (python-can) #140

Closed
mdabrowski1990 opened this issue Dec 6, 2021 · 2 comments · Fixed by #241
Closed

Prepare user documentation for Transport Interface (python-can) #140

mdabrowski1990 opened this issue Dec 6, 2021 · 2 comments · Fixed by #241
Assignees
Labels
CAN Related to CAN specific implementation documentation Improvements or additions to documentation

Comments

@mdabrowski1990
Copy link
Owner

mdabrowski1990 commented Dec 6, 2021

Requires

#22

Description

As a user, I would like to have documentation "how to use" Transport Interface for python-can, so I could follow the guide.
As a developer, I would like to provide tutorials for the user, so I do not have to explain it every time by myself.

Testing

With the guide as the only source of information, a user is able to send and receive trial CAN Packet(s).
Preferable, someone fresh to follow these steps as review.

Acceptance Criteria

  • page for python-can Transport Interface created in User Documentation
    • configuration tutorial with explanations (and references to knowledge base)
    • use cases are described (send/receive CAN packet)
@mdabrowski1990 mdabrowski1990 added the documentation Improvements or additions to documentation label Dec 6, 2021
@mdabrowski1990 mdabrowski1990 added the CAN Related to CAN specific implementation label Dec 6, 2021
@mdabrowski1990 mdabrowski1990 changed the title [refine] Prepare user documentation for Transport Interface (python-can) Prepare user documentation for Transport Interface (python-can) Dec 7, 2021
@mdabrowski1990 mdabrowski1990 self-assigned this Oct 25, 2023
@mdabrowski1990
Copy link
Owner Author

mdabrowski1990 commented Oct 26, 2023

Builds started to fail (https://readthedocs.org/projects/uds/builds/) due to changes in ReadTheDocs configuration. Currently, the only problem is related to graphviz not being found - https://stackoverflow.com/questions/77366687/how-to-make-readthedocs-build-graphs-using-graphviz

Make sure to restore default setting in build configuration once the issue with building is fixed

@mdabrowski1990
Copy link
Owner Author

I have managed to fix the graphviz issue. Resolution was also posted in the stackoverflow ticket.
image

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
None yet
Development

Successfully merging a pull request may close this issue.

1 participant