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.

88 lines
2.3 KiB

  1. site_name: developing
  2. site_url: https://docs.hello-robot.com/stretch_tutorials
  3. site_description: "Hello Robot Stretch Tutorials"
  4. copyright: 'Copyright © 2022 Hello Robot Inc'
  5. site_author: Hello Robot Inc
  6. use_directory_urls: True
  7. docs_dir: developing
  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. - ./extra.css
  29. markdown_extensions:
  30. - pymdownx.highlight
  31. - pymdownx.superfences
  32. - pymdownx.inlinehilite
  33. - pymdownx.keys
  34. - admonition
  35. - pymdownx.tabbed:
  36. alternate_style: true
  37. plugins:
  38. - same-dir
  39. # - simple:
  40. # merge_docs_dir: true
  41. # include_extensions: [".css", ".png"]
  42. # include_folders: ['../hello_helpers']
  43. - mike:
  44. # these fields are all optional; the defaults are as below...
  45. version_selector: true # set to false to leave out the version selector
  46. css_dir: css # the directory to put the version selector's CSS
  47. javascript_dir: js # the directory to put the version selector's JS
  48. canonical_version: null # the version for <link rel="canonical">; `null`
  49. # uses the version specified via `mike deploy`
  50. - search
  51. - tags
  52. - mkdocstrings:
  53. default_handler: python
  54. handlers:
  55. python:
  56. selection:
  57. docstring_style: numpy
  58. rendering:
  59. show_root_heading: true
  60. show_source: false
  61. members_order: source
  62. heading_level: 3
  63. show_if_no_docstring: true
  64. extra:
  65. version:
  66. provider: mike
  67. default: latest
  68. social:
  69. - icon: material/home
  70. link: https://hello-robot.com
  71. - icon: material/twitter
  72. link: https://twitter.com/HelloRobotInc
  73. - icon: material/github
  74. link: https://github.com/hello-robot
  75. - icon: material/linkedin
  76. link: https://linkedin.com/company/hello-robot-inc
  77. nav:
  78. - The Basics: ./basics.md
  79. # - Networking Guide: ./networking.md # TODO
  80. # - Command Line Tools: ./cli.md
  81. # - Using Python with Stretch: ./python.md