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

Updated documentation #228

Merged
merged 25 commits into from
Dec 18, 2024
Merged

Updated documentation #228

merged 25 commits into from
Dec 18, 2024

Conversation

urfeex
Copy link
Member

@urfeex urfeex commented Dec 4, 2024

This PR aims at improving the library's documentation.

@urfeex urfeex force-pushed the updated_documentation branch 4 times, most recently from c7ed481 to 0fea2ba Compare December 12, 2024 11:42
@urfeex urfeex requested review from urmahp and urrsk December 12, 2024 11:43
@urfeex urfeex marked this pull request as ready for review December 12, 2024 11:43
@urfeex urfeex force-pushed the updated_documentation branch from 0fea2ba to e55aeee Compare December 12, 2024 11:46
@urfeex urfeex requested a review from pheobeyeung December 12, 2024 12:01
doc/installation.rst Outdated Show resolved Hide resolved
doc/architecture/reverse_interface.rst Outdated Show resolved Hide resolved
doc/architecture/rtde_client.rst Outdated Show resolved Hide resolved
doc/architecture/script_command_interface.rst Show resolved Hide resolved
Copy link
Collaborator

@urmahp urmahp left a comment

Choose a reason for hiding this comment

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

Overall it looks good and I am fine with merging this, I have a added a couple of small suggestions to something that could be changed.

doc/architecture/dashboard_client.rst Outdated Show resolved Hide resolved
doc/architecture/reverse_interface.rst Outdated Show resolved Hide resolved
doc/architecture/reverse_interface.rst Outdated Show resolved Hide resolved
urfeex and others added 3 commits December 16, 2024 16:22
Co-authored-by: Mads Holm Peters <79145214+urmahp@users.noreply.github.com>
Co-authored-by: Rune Søe-Knudsen <41109954+urrsk@users.noreply.github.com>
@urfeex urfeex force-pushed the updated_documentation branch from 6ced4e9 to 8b9fb9f Compare December 16, 2024 16:10
@urfeex urfeex requested a review from urrsk December 16, 2024 16:18
Copy link

codecov bot commented Dec 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 72.03%. Comparing base (d21a402) to head (6748694).
Report is 48 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #228      +/-   ##
==========================================
- Coverage   72.05%   72.03%   -0.03%     
==========================================
  Files          71       71              
  Lines        2652     2786     +134     
  Branches      337      353      +16     
==========================================
+ Hits         1911     2007      +96     
- Misses        555      587      +32     
- Partials      186      192       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@urfeex urfeex merged commit 6bc1553 into master Dec 18, 2024
29 of 37 checks passed
@urfeex urfeex deleted the updated_documentation branch December 18, 2024 07:35
urfeex added a commit to urfeex/Universal_Robots_Client_Library that referenced this pull request Jan 10, 2025
* Update sphinx theme
* Update welcome page with a one-liner
* Update installation / build instructions
* Update ScriptSender documentation with example
* Update rtde client documentation
* Add ci job for building the docs
* Update dashboard client documentation
* Add script command interface documentation
* Add reverse_interface documentation
* Add trajectory_point_interface documentation
* Move UrDriver component description to own file
* Update architecture overview graph
* Add notes about PolyScope X compatibility
This was referenced Jan 14, 2025
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.

3 participants