Skip to content

Add Sphinx documentation#9

Merged
urfeex merged 5 commits intomainfrom
sphinx_documentation
May 5, 2026
Merged

Add Sphinx documentation#9
urfeex merged 5 commits intomainfrom
sphinx_documentation

Conversation

@srvald
Copy link
Copy Markdown
Collaborator

@srvald srvald commented Apr 30, 2026

This pull request introduces the Sphinx documentation for the ur_rtde_publisher package.

The documentation includes:

  • An overview of the package purpose
  • An architecture description
  • Installation steps
  • Usage instructions and a launch example

The README has also been modified. While it includes a few minor content adjustments, the main change is that it has been converted from Markdown (.md) to reStructuredText (.rst). This makes it easier to include it directly in the Sphinx documentation as an overview page.

This PR only adds documentation and does not modify runtime behavior.

Copy link
Copy Markdown
Member

@urfeex urfeex left a comment

Choose a reason for hiding this comment

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

I think, we are good, at least for a first version.

@urfeex urfeex merged commit d82c0a9 into main May 5, 2026
4 of 5 checks passed
@urfeex urfeex deleted the sphinx_documentation branch May 5, 2026 14: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