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

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