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.

Sign up for GitHub

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

Jump to bottom

Update documentation for Read the Docs #110

Merged
merged 1 commit into from
Jul 28, 2022
Merged

Update documentation for Read the Docs #110

merged 1 commit into from
Jul 28, 2022

Conversation

IsabelParedes
Copy link
Collaborator

@IsabelParedes IsabelParedes commented Jul 28, 2022 •
edited
Loading

With this PR, the documentation for Read the Docs is updated. This is intended for version 0.6.0 of jupyros.

Things not included:

  • The "References" page still needs to be updated, but this requires modifying the comment blocks in the python package to align with the sphinx format.
  • The content "ROS 3D Widgets" page was mostly unmodified (other than formatting), this requires more testing of the widgets to see if they can be used with the updated instructions or if more information needs to be provided.
  • There is currently no information about the thread_cell magic
  • Playing bag files and live plotting are not documented because some issues were encountered during testing

@IsabelParedes
Update documentation
441d1f8 
Update reference documentation

Add developer installation and contributing guide

Update docs configuration

Organize files

Add README for building docs

Fix links and emojis

Fix titles

Add getting started page

Update and fix formatting

Add testing page

Add support page

Fix spacing

Update troubleshooting guide and server page

Update ROS widget documentation

Prettify
@hbcarlos
Copy link
Member

Thanks, @ihuicatl!

@hbcarlos hbcarlos merged commit 59892d5 into RoboStack:master Jul 28, 2022
@IsabelParedes IsabelParedes deleted the docs branch July 28, 2022 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@IsabelParedes @hbcarlos