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

Add sphinx documentation #340

Merged
merged 7 commits into from
Apr 25, 2022
Merged

Add sphinx documentation #340

merged 7 commits into from
Apr 25, 2022

Conversation

fmauch
Copy link
Contributor

@fmauch fmauch commented Apr 19, 2022

Migrate the docs folder towards using sphinx. My goal here is to have a complete documentation that can be built using rosdoc2 so we have a place for a rendered documentation outside the repo once we use binary releases.

@fmauch fmauch added this to the Galactic release milestone Apr 19, 2022
@fmauch
Copy link
Contributor Author

fmauch commented Apr 19, 2022

This will currently conflict with #333 but that shouldn't be a problem to update once #333 is merged.

@fmauch fmauch mentioned this pull request Apr 19, 2022
Closed
4 tasks
@fmauch fmauch force-pushed the rosdoc branch 3 times, most recently from c3d5adc to f6f62a9 Compare April 20, 2022 09:52
@fmauch fmauch linked an issue Apr 21, 2022 that may be closed by this pull request
URSim Docker Issue #318
Closed
@fmauch fmauch linked an issue Apr 21, 2022 that may be closed by this pull request
documentation... #93
Closed
@fmauch fmauch requested a review from t-schnell April 21, 2022 13:54
@fmauch fmauch marked this pull request as ready for review April 21, 2022 13:54
destogl
destogl approved these changes Apr 24, 2022
View reviewed changes
Copy link
Contributor

@destogl destogl left a comment

Choose a reason for hiding this comment

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

This looks fine to me.

DISCLAIMER: I only checked the files and didn't try to build this locally, because I am not sure how to use rosdoc2

@fmauch fmauch merged commit 082dd2a into main Apr 25, 2022
@fmauch fmauch deleted the rosdoc branch April 25, 2022 05:32
This was referenced Apr 28, 2022
Merged
Merged
@RobertWilbrandt RobertWilbrandt mentioned this pull request Jun 9, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@destogl destogl destogl approved these changes

@t-schnell t-schnell Awaiting requested review from t-schnell

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
Galactic release
Development

Successfully merging this pull request may close these issues.

URSim Docker Issue documentation...
2 participants
@fmauch @destogl