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.
 

92 lines
2.4 KiB

site_name: python
site_url: https://docs.hello-robot.com/stretch_tutorials
site_description: "Hello Robot Stretch Tutorials"
copyright: 'Copyright © 2022 Hello Robot Inc'
site_author: Hello Robot Inc
use_directory_urls: True
docs_dir: python
site_dir: ../site
theme:
name: material
#font: Arial
palette:
- scheme: default
primary: hello-robot-light
toggle:
icon: material/lightbulb-outline
name: Switch to dark mode
- scheme: slate
primary: hello-robot-dark
toggle:
icon: material/lightbulb
name: Switch to light mode
logo: images/hello_robot_logo_light.png
favicon: images/hello_robot_favicon.png
features:
- navigation.instant
extra_css:
- ./extra.css
markdown_extensions:
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.inlinehilite
- pymdownx.keys
- admonition
- pymdownx.tabbed:
alternate_style: true
plugins:
- same-dir
# - simple:
# merge_docs_dir: true
# include_extensions: [".css", ".png"]
# include_folders: ['../hello_helpers']
- mike:
# these fields are all optional; the defaults are as below...
version_selector: true # set to false to leave out the version selector
css_dir: css # the directory to put the version selector's CSS
javascript_dir: js # the directory to put the version selector's JS
canonical_version: null # the version for <link rel="canonical">; `null`
# uses the version specified via `mike deploy`
- search
- tags
- mkdocstrings:
default_handler: python
handlers:
python:
selection:
docstring_style: numpy
rendering:
show_root_heading: true
show_source: false
members_order: source
heading_level: 3
show_if_no_docstring: true
extra:
version:
provider: mike
default: latest
social:
- icon: material/home
link: https://hello-robot.com
- icon: material/twitter
link: https://twitter.com/HelloRobotInc
- icon: material/github
link: https://github.com/hello-robot
- icon: material/linkedin
link: https://linkedin.com/company/hello-robot-inc
nav:
- ./moving.md
- Thread Safety: https://github.com/hello-robot/stretch_body/blob/master/docs/is_thread_safe/README.md
# - ./sensors.md # TODO
# - ./audio.md
# - ./pyfunmap.md
# - ./ik.md
# - ./visual_servoing.md
# - ./other.md