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

Improving docs #523

Merged
merged 6 commits into from
Aug 27, 2021
Merged

Improving docs #523

merged 6 commits into from
Aug 27, 2021

Conversation

ivanpauno
Copy link
Member

@ivanpauno ivanpauno commented Aug 25, 2021

  • Fix DeclareLaunchArgument reference in architecture.rst
  • Fixes in sphinx conf.py:
    • Deleted html_static_path (there's no _static folder)
    • Add options to make class/constructor docs nicer (don't merge init signature with the class name, document init and the class separately).
    • There are other issues like methods with type hints being rendered horribly.
      IIUC the only way to fix that is to provide a custom .css file, which I haven't added (see this issue).
  • Add python and xml examples in DeclareLaunchArgument.
  • Make pytest run doctests, I needed to add some extra conftest.py files to make this work.

My idea is to add simular examples to all actions/substitutions, and then revamp the architecture docs (I'll probably split that in a more basic intro, reference documentation of all actions and substitution, and then the more detailed architecture).

Signed-off-by: Ivan Santiago Paunovic <[email protected]>
Signed-off-by: Ivan Santiago Paunovic <[email protected]>
Signed-off-by: Ivan Santiago Paunovic <[email protected]>
Signed-off-by: Ivan Santiago Paunovic <[email protected]>
@ivanpauno ivanpauno added the enhancement New feature or request label Aug 25, 2021
@ivanpauno ivanpauno self-assigned this Aug 25, 2021
@ivanpauno
Copy link
Member Author

We will actually have the generated docs when ros-infrastructure/rosdoc2#28 is merged.

Copy link
Contributor

@hidmic hidmic left a comment

Choose a reason for hiding this comment

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

I like where this is headed.

launch/conftest.py Show resolved Hide resolved
launch/launch/actions/conftest.py Outdated Show resolved Hide resolved
launch/launch/actions/declare_launch_argument.py Outdated Show resolved Hide resolved
Copy link
Member

@jacobperron jacobperron left a comment

Choose a reason for hiding this comment

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

LGTM with CI

launch/conftest.py Outdated Show resolved Hide resolved
launch/launch/actions/declare_launch_argument.py Outdated Show resolved Hide resolved
Signed-off-by: Ivan Santiago Paunovic <[email protected]>
Signed-off-by: Ivan Santiago Paunovic <[email protected]>
@ivanpauno
Copy link
Member Author

CI:

  • Linux Build Status
  • Linux-aarch64 Build Status
  • macOS Build Status
  • Windows Build Status

@ivanpauno ivanpauno merged commit dc050b2 into master Aug 27, 2021
@delete-merged-branch delete-merged-branch bot deleted the ivanpauno/improving-docs branch August 27, 2021 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants