Skip to content

Conversation

urfeex
Copy link
Member

@urfeex urfeex commented Jan 31, 2025

Add documentation text about the examples in the user documentation.

I simplified some of the examples on the way.

@urfeex urfeex requested a review from a team January 31, 2025 13:27
@urfeex urfeex force-pushed the doc_examples branch 2 times, most recently from be42078 to 7c1c9f6 Compare February 3, 2025 11:04
Copy link

codecov bot commented Feb 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.08%. Comparing base (2c12bee) to head (122020f).
Report is 24 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #258      +/-   ##
==========================================
+ Coverage   71.71%   73.08%   +1.37%     
==========================================
  Files          71       76       +5     
  Lines        2786     2969     +183     
  Branches      353      379      +26     
==========================================
+ Hits         1998     2170     +172     
- Misses        596      600       +4     
- Partials      192      199       +7     

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

@urrsk
Copy link
Member

urrsk commented Feb 4, 2025

should there be a :github_url: in the begining of all the rst files?

@urfeex
Copy link
Member Author

urfeex commented Feb 4, 2025

should there be a :github_url: in the begining of all the rst files?

I wanted to do that in a separate PR, yes. This will make the "Edit on Github" button in the hosted documentation work correctly.

@urrsk
Copy link
Member

urrsk commented Feb 4, 2025

@urfeex Thanks for the effort

* Move ur_driver example docs to examples subfolder
* Update example documentation for ur_driver example
* Add dashboard_client example documentation
* Add documentation for force_mode example
* Add documentation for freedrive mode example
* Add instruction_executor example doc
* Add example documentation for primary_pipeline
* Add example documentation for primary_pipeline_calibration
* Add example documentation for RTDE client
* Add documentation for script sender example
* Add example documentation for tool contact
* Add example documentation for spline example
* Add example documentation for trajectory_point_interface
* Make sure the real_time doc string is picked up by the URL check
* Do not check already checked links in url_check
  This should greatly speed up things
@urfeex urfeex merged commit 88d31b9 into UniversalRobots:master Feb 4, 2025
20 of 23 checks passed
@urfeex urfeex deleted the doc_examples branch February 4, 2025 11:18
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.

2 participants