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

Add support for sphinx documentation #228

Merged
merged 4 commits into from
Jul 13, 2021
Merged

Add support for sphinx documentation #228

merged 4 commits into from
Jul 13, 2021

Conversation

ayrton04
Copy link
Contributor

@ayrton04 ayrton04 commented Jul 9, 2021

Making a start at Sphinx documentation for this package. If anyone is aware if rosdoc works with metapackages, I can get rid of fuse_doc and just put this in the fuse package itself. But I was under the impression that wasn't supported by metapackages.

My plans going forward will be to:

  • For the tutorial I added, I want to upload the bag I used to an S3 bucket and make it publicly available
  • Add doxygen documentation via rosdoc_lite for every package in the metapackage
  • Document all the options for all the different models, sensors, etc.
  • Add more advanced tutorials

But we'll do all of that in future PRs. For now, this should serve as a decent starting point.

@ayrton04 ayrton04 changed the title Adding tutorial for basic configuration Add support for sphinx documentation Jul 9, 2021
fuse_doc/doc/getting_started.rst Outdated Show resolved Hide resolved
fuse_doc/doc/getting_started.rst Outdated Show resolved Hide resolved
fuse_doc/doc/getting_started.rst Outdated Show resolved Hide resolved
fuse_doc/doc/getting_started.rst Outdated Show resolved Hide resolved
fuse_doc/doc/getting_started.rst Outdated Show resolved Hide resolved
fuse_doc/doc/getting_started.rst Outdated Show resolved Hide resolved
fuse_doc/doc/getting_started.rst Outdated Show resolved Hide resolved
fuse_doc/doc/getting_started.rst Outdated Show resolved Hide resolved
fuse_doc/doc/getting_started.rst Outdated Show resolved Hide resolved
fuse_doc/doc/index.rst Outdated Show resolved Hide resolved
@ayrton04
Copy link
Contributor Author

OK, I believe I've addressed all the PR feedback. I also uploaded a bag file and rviz display (in a .tar.xz file) to support the tutorial.

@ayrton04 ayrton04 requested a review from efernandez July 12, 2021 10:16
@ayrton04
Copy link
Contributor Author

@svwilliams, any objection to also moving all of your .md documentation files over to this as well? Or do you want that stuff to live in the repo? Obviously not for this PR.

Copy link
Collaborator

@efernandez efernandez left a comment

Choose a reason for hiding this comment

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

I haven't run the tutorial, but it LGTM

@ayrton04 ayrton04 merged commit 99fcf1b into devel Jul 13, 2021
@ayrton04 ayrton04 deleted the doc branch July 13, 2021 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants