You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

97 lines
2.8 KiB

  1. site_name: Stretch ROS
  2. site_url: https://docs.hello-robot.com/stretch_ros
  3. site_description: "Hello Robot Stretch ROS Documentation"
  4. copyright: 'Copyright © 2022 Hello Robot Inc'
  5. site_author: Hello Robot Inc
  6. use_directory_urls: True
  7. docs_dir: .
  8. site_dir: ../site
  9. theme:
  10. name: material
  11. features:
  12. - navigation.instant
  13. - navigation.footer
  14. #font: Arial
  15. palette:
  16. - scheme: default
  17. primary: hello-robot-light
  18. toggle:
  19. icon: material/lightbulb-outline
  20. name: Switch to dark mode
  21. - scheme: slate
  22. primary: hello-robot-dark
  23. toggle:
  24. icon: material/lightbulb
  25. name: Switch to light mode
  26. logo: images/hello_robot_logo_light.png
  27. favicon: images/hello_robot_favicon.png
  28. extra_css:
  29. - ./docs/extra.css
  30. markdown_extensions:
  31. - pymdownx.highlight
  32. - pymdownx.superfences
  33. - pymdownx.inlinehilite
  34. - pymdownx.keys
  35. - admonition
  36. - pymdownx.tabbed:
  37. alternate_style: true
  38. plugins:
  39. - same-dir
  40. # - simple:
  41. # merge_docs_dir: true
  42. # include_extensions: [".css", ".png"]
  43. # include_folders: ['../hello_helpers']
  44. - mike:
  45. # these fields are all optional; the defaults are as below...
  46. version_selector: true # set to false to leave out the version selector
  47. css_dir: css # the directory to put the version selector's CSS
  48. javascript_dir: js # the directory to put the version selector's JS
  49. canonical_version: null # the version for <link rel="canonical">; `null`
  50. # uses the version specified via `mike deploy`
  51. - search
  52. - tags
  53. - mkdocstrings:
  54. default_handler: python
  55. handlers:
  56. python:
  57. selection:
  58. docstring_style: numpy
  59. rendering:
  60. show_root_heading: true
  61. show_source: false
  62. members_order: source
  63. heading_level: 3
  64. show_if_no_docstring: true
  65. extra:
  66. version:
  67. provider: mike
  68. default: latest
  69. social:
  70. - icon: material/home
  71. link: https://hello-robot.com
  72. - icon: material/twitter
  73. link: https://twitter.com/HelloRobotInc
  74. - icon: material/github
  75. link: https://github.com/hello-robot
  76. - icon: material/linkedin
  77. link: https://linkedin.com/company/hello-robot-inc
  78. nav:
  79. - Overview: README.md
  80. - Tutorials: https://docs.hello-robot.com/0.2/stretch-tutorials/ros1/
  81. - Packages:
  82. - hello_helpers: ./hello_helpers/README.md
  83. - stretch_calibration: ./stretch_calibration/README.md
  84. - stretch_core: ./stretch_core/README.md
  85. - stretch_deep_perception: ./stretch_deep_perception/README.md
  86. - stretch_demos: ./stretch_demos/README.md
  87. - stretch_description: ./stretch_description/README.md
  88. - stretch_funmap: ./stretch_funmap/README.md
  89. - stretch_gazebo: ./stretch_gazebo/README.md
  90. - stretch_moveit_config: ./stretch_moveit_config/README.md
  91. - stretch_navigation: ./stretch_navigation/README.md