Skip to content

Update documentation with plugins, related tools etc. #1457

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

Merged
merged 21 commits into from
Dec 19, 2022

Conversation

MattWoodhead
Copy link
Contributor

@MattWoodhead MattWoodhead commented Dec 11, 2022

An update to the documentation to add reference to some modules using the plugin interface, and in adition add some references to tools related to python-can to address #1041

Todo:

  • Add example plugins to optional dependencies list as already noted elsewhere in the docs.
  • Add more details and modules to the new "Other Tools" page
  • Check documentation changes render correctly.

MattWoodhead and others added 9 commits December 10, 2022 23:15
@MattWoodhead MattWoodhead marked this pull request as ready for review December 12, 2022 22:13
@zariiii9003
Copy link
Collaborator

@MattWoodhead I will review this on the weekend or next week. For now, could you resolve the new sphinx warnings?
https://github.com/hardbyte/python-can/actions/runs/3680103958/jobs/6225323383#step:5:118

Copy link
Owner

@hardbyte hardbyte left a comment

Choose a reason for hiding this comment

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

Thanks, great job

MattWoodhead and others added 3 commits December 17, 2022 09:09
fix note block

Co-authored-by: Brian Thorne <hardbyte@gmail.com>
Co-authored-by: Brian Thorne <hardbyte@gmail.com>
Copy link
Collaborator

@zariiii9003 zariiii9003 left a comment

Choose a reason for hiding this comment

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

Overall great work, thank you for the contribution. 👍

Some things should be changed though.

MattWoodhead and others added 8 commits December 17, 2022 15:36
Co-authored-by: zariiii9003 <52598363+zariiii9003@users.noreply.github.com>
Co-authored-by: zariiii9003 <52598363+zariiii9003@users.noreply.github.com>
Co-authored-by: zariiii9003 <52598363+zariiii9003@users.noreply.github.com>
Co-authored-by: zariiii9003 <52598363+zariiii9003@users.noreply.github.com>
Co-authored-by: zariiii9003 <52598363+zariiii9003@users.noreply.github.com>
Co-authored-by: zariiii9003 <52598363+zariiii9003@users.noreply.github.com>
@zariiii9003
Copy link
Collaborator

I just noticed, the enumerated lists do not seem to work as intended:
image

Fix numbering of lists. Correct careless spelling errors.
@MattWoodhead
Copy link
Contributor Author

I just noticed, the enumerated lists do not seem to work as intended:

Sorry, I think I must have broken those when I tried to sort out the sphinx warnings.

@zariiii9003 zariiii9003 linked an issue Dec 19, 2022 that may be closed by this pull request
@zariiii9003 zariiii9003 merged commit f3136fb into hardbyte:develop Dec 19, 2022
@felixdivo
Copy link
Collaborator

Awesome!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation page on related tools
4 participants