Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
367 lines (354 loc) · 16 KB
/
Copy pathmkdocs.yml
File metadata and controls
367 lines (354 loc) · 16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
site_name: STEPFOC
site_description: Documentation for the STEPFOC stepper motor FOC driver by Source Robotics.
# Where the site is published: the organisation's docs domain, this repository's path. Search engines take each
# page's address from here, and the sitemap is built from it. mike adds the version under it (/STEPFOC-docs/108/).
site_url: https://docs.source-robotics.com/STEPFOC-docs/
# The docs repository: the "edit this page" target. The header card points at the firmware repository instead
# (extra.repos below, overrides/partials/source.html).
repo_url: https://github.com/Source-Robotics/STEPFOC-docs
repo_name: Source-Robotics/STEPFOC-docs
edit_uri: edit/main/docs/
copyright: |
© 2026 <a href="https://source-robotics.com" target="_blank" rel="noopener">Source Robotics d.o.o.</a> ·
Text and images <a href="https://creativecommons.org/licenses/by-sa/4.0/" target="_blank" rel="noopener">CC BY-SA 4.0</a> ·
Code examples <a href="https://github.com/Source-Robotics/STEPFOC-docs/blob/main/LICENSE-CODE" target="_blank" rel="noopener">MIT</a>
theme:
name: material
custom_dir: overrides
logo: assets/logo_new_2.png
favicon: assets/favicon.png
language: en
font: false # Roboto is served from the site: docs/stylesheets/fonts.css
icon:
repo: fontawesome/brands/github
edit: material/pencil
view: material/eye
features:
- navigation.instant # pages load without a full reload: faster, the scroll of the sidebar is kept
- navigation.instant.prefetch # a page is fetched while the pointer hovers its link
- navigation.instant.progress # a progress bar when a page takes long
- navigation.prune # the sidebar carries only the visible part of the navigation: smaller pages
- navigation.tabs # one tab per part: Manual, API reference, Guides, Support
- navigation.tabs.sticky
- navigation.sections # the bold sidebar groups
- navigation.indexes # a chapter is a folder with its own page
- navigation.footer # Previous / Next
- navigation.top
- navigation.path
- toc.follow
- search.suggest
- search.highlight
- search.share
- content.tabs.link
- content.code.copy
- content.code.annotate
- content.action.view
- content.action.edit
- content.tooltips # title="..." on links and abbreviations become tooltips
- content.footnote.tooltips
palette: # the same as the PAR6 docs
- scheme: slate # dark by default
primary: black
accent: green
toggle:
icon: material/weather-night
name: Switch to light mode
- scheme: default
primary: black
accent: green
toggle:
icon: material/weather-sunny
name: Switch to dark mode
plugins:
- search
- glightbox # click any image to zoom
- git-revision-date-localized: # "Last update" under every page, from its last commit
type: date
fallback_to_build_date: true # a shallow checkout or a file git does not know yet
exclude:
- includes/*
- social:
cards_layout: default
enabled: !ENV [ENABLE_SOCIAL, false] # social cards only in CI (ENABLE_SOCIAL=true; they need Cairo + Pillow)
# The addresses of the pages before the manual was restructured (firmware 103 and older) keep working.
- redirects:
redirect_maps:
specs.md: 03-technical-data/ratings.md
getting_started.md: 04-mounting/index.md
flashing_firmware.md: 07-firmware/index.md
calibration.md: 05-setup/calibration.md
PID_tuning.md: 05-setup/tuning.md
uart.md: reference/uart/index.md
can.md: reference/can/index.md
theory_corner.md: appendix/theory.md
tested_motors.md: 03-technical-data/tested-motors.md
troubleshooting.md: 08-troubleshooting/index.md
Guides/Python_guide.md: guides/python.md
Guides/Quadruped_guide.md: guides/quadruped.md
Guides/Gravity_compensation_guide.md: guides/gravity-compensation.md
Guides/Bilateral_teleoperation_guide.md: guides/bilateral-teleoperation.md
# One page with the whole manual (print_page/), for the PDF: hooks/pdf.py prints it with Chrome when DOCS_PDF is
# set. Must stay the last plugin.
- print-site:
add_to_navigation: false
print_page_title: "STEPFOC, the whole manual"
add_table_of_contents: true
toc_depth: 2
enumerate_headings: false
enumerate_figures: false
add_cover_page: true
add_print_site_banner: false
# The version facts of versions.yml written into the pages (the version box and the list of documents), and the
# reference pages built from the firmware facts (docs/includes/generated/firmware_facts.json, written by
# tools/sync_firmware.py from the release tag) and the hand-written command descriptions (docs/includes/*.yml).
hooks:
- hooks/versions.py
- hooks/firmware_pages.py
- hooks/can_tools.py # versioned CAN downloads and the offline frame tool
- hooks/known_issues.py # the known issues table from known_issues.yml
- hooks/llms.py # the Markdown twins, llms.txt and llms-full.txt from the content hooks' output
- hooks/figures.py # captions: standalone pictures become numbered figures (after llms.py: twins keep plain pictures)
- hooks/pdf.py # the PDF of the manual, from the print-site page, when DOCS_PDF is set
markdown_extensions:
- admonition
- attr_list
- md_in_html
- tables
- def_list
- footnotes
- abbr
- toc:
permalink: true
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.snippets:
base_path:
- docs/includes
check_paths: true
auto_append:
- abbreviations.md # site-wide abbreviations -> tooltips on every page
- pymdownx.arithmatex:
generic: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.smartsymbols:
fractions: false # "rail 1/2/3" is three numbers, not one half and a 3
extra:
# Google Analytics 4 (one property for every docs site, the shared domain) and "Was this page helpful?" at the
# end of every page: Material's integration records the page views and sends the votes as events named
# "feedback". Both load only after the reader accepts the cookie banner (consent below).
analytics:
provider: google
property: G-1DFG9VZDEB
feedback:
title: Was this page helpful?
ratings:
- icon: material/thumb-up-outline
name: This page was helpful
data: 1
note: Thanks for your feedback!
- icon: material/thumb-down-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback! Tell us what is missing in
<a href="https://github.com/Source-Robotics/STEPFOC-docs/issues/new" target="_blank" rel="noopener">an issue</a>,
or on Discord.
# The cookie banner the EU requires for Google Analytics; the analytics load only after "Accept".
consent:
title: Cookie consent
description: >-
We use cookies to see which pages are read and whether readers find what they look for.
With your consent, you help us make this documentation better.
actions:
- accept
- reject
- manage
# Comments under every page, through Giscus. All the docs sites share one Discussions home, the
# organisation's Discussions (https://github.com/orgs/Source-Robotics/discussions, source repository
# Source-Robotics/discussions), category "Manual comments": one thread per site and page, created when
# the first reader comments, answered where the questions are. The IDs are the source repository's and
# the category's; giscus.app shows them. Empty IDs: no comments are rendered. A page opts out with
# `comments: false` in its front matter. The giscus app must have access to Source-Robotics/discussions.
comments:
repo: Source-Robotics/discussions
repo_id: "R_kgDOVipxrA"
category: Manual comments
category_id: "DIC_kwDOVipxrM4DKcet"
# The published version the Markdown twins and llms.txt link to (mike publishes each build under its version).
# Markdown exports use the release from versions.yml, including on archived versions.
# The PDF of the manual (hooks/pdf.py): the file under site/, written when DOCS_PDF is set.
pdf:
file: assets/STEPFOC-manual.pdf
# The version selector in the header (built by mike: one entry per published firmware release + "latest").
version:
provider: mike
default: latest
alias: true
# The header's repository card per section (overrides/partials/source.html): page-URL prefix -> repository.
# A longer prefix listed later overrides a shorter one listed earlier.
repos:
- prefix: ""
name: Source-Robotics/STEPFOC-stepper-controller
url: https://github.com/Source-Robotics/STEPFOC-stepper-controller
- prefix: guides/
name: Source-Robotics/Spectral-BLDC-Python
url: https://github.com/Source-Robotics/Spectral-BLDC-Python
- prefix: reference/python/
name: Source-Robotics/Spectral-BLDC-Python
url: https://github.com/Source-Robotics/Spectral-BLDC-Python
social:
- icon: fontawesome/brands/github
link: https://github.com/Source-Robotics
- icon: fontawesome/brands/youtube
link: https://www.youtube.com/@source-robotics
- icon: fontawesome/brands/instagram
link: https://www.instagram.com/source_robotics/
- icon: fontawesome/brands/x-twitter
link: https://twitter.com/SourceRobotics
- icon: fontawesome/brands/linkedin
link: https://www.linkedin.com/company/source-robotics
- icon: fontawesome/brands/discord
link: https://discord.gg/prjUvjmGpZ
- icon: fontawesome/brands/tiktok
link: https://www.tiktok.com/@source.robotics
# Page status markers (front matter `status: ...`) shown as an icon in the sidebar.
status:
new: Recently added
deprecated: Deprecated
draft: Not written yet
extra_css:
- stylesheets/fonts.css # the self-hosted fonts
- stylesheets/extra.css
extra_javascript:
- javascripts/mathjax.js
- javascripts/can-tools.js
- javascripts/copy-markdown.js # the "Copy this page as Markdown" button
- javascripts/units-calculator.js # the units calculator on Control modes
- javascripts/gripper-viewer-loader.js # the 3D board viewer, only on pages that have one
- javascripts/mathjax-loader.js # loads MathJax only on pages with a formula
- javascripts/vendor/tablesort.min.js # sortable tables (click a header); tablesort 5.3.0, served from the site
- javascripts/tablesort.js
exclude_docs: |
includes/
validation:
omitted_files: warn
absolute_links: warn
unrecognized_links: warn
nav:
- STEPFOC Manual:
- index.md
- Before you start:
- Quick start:
- quick-start/index.md
- 1. Fit the motor: quick-start/1-motor.md
- 2. Connect: quick-start/2-connect.md
- 3. Calibrate: quick-start/3-calibrate.md
- 4. First moves: quick-start/4-first-moves.md
- About this manual: about.md
- Chapters:
- 1. Overview:
- 01-overview/index.md
- The driver at a glance: 01-overview/driver-at-a-glance.md
- STEPFOC and Spectral Micro: 01-overview/stepfoc-and-spectral.md
- What you need: 01-overview/what-you-need.md
- 2. Safety: 02-safety.md
- 3. Technical data:
- 03-technical-data/index.md
- Ratings and limits: 03-technical-data/ratings.md
- Connectors and pinout: 03-technical-data/connectors.md
- Dimensions and CAD: 03-technical-data/dimensions.md
- Tested motors: 03-technical-data/tested-motors.md
- 4. Mounting and wiring:
- 04-mounting/index.md
- The encoder magnet: 04-mounting/magnet.md
- Mounting on the motor: 04-mounting/mounting.md
- Wiring the stepper: 04-mounting/wiring.md
- Power and the CAN daisy chain: 04-mounting/power-and-can.md
- Thermistor: 04-mounting/thermistor.md
- 5. First setup:
- 05-setup/index.md
- Motor GUI: 05-setup/motor-gui.md
- The serial terminal: 05-setup/terminal.md
- Motor parameters and calibration: 05-setup/calibration.md
- Encoder table and anti-cogging: 05-setup/anti-cogging.md
- Current limit and loop tuning: 05-setup/tuning.md
- Saving the configuration: 05-setup/saving.md
- 6. Operation:
- 06-operation/index.md
- Control modes: 06-operation/modes.md
- Over UART: 06-operation/uart.md
- Over CAN: 06-operation/can.md
- The watchdog: 06-operation/watchdog.md
- With Python: 06-operation/python.md
- Working in Motor GUI: 06-operation/motor-gui.md
- Errors and recovery: 06-operation/errors.md
- Status and diagnostics: 06-operation/diagnostics.md
- Sound: 06-operation/sound.md
- Gripper mode: 06-operation/gripper-mode.md
- 7. Firmware:
- 07-firmware/index.md
- Releases and versions: 07-firmware/releases.md
- The bootloader: 07-firmware/the-bootloader.md
- Updating through the bootloader: 07-firmware/update.md
- Upgrading from older firmware: 07-firmware/upgrading.md
- Installing the bootloader on an older board: 07-firmware/bootloader.md
- Building from source: 07-firmware/building.md
- 8. Troubleshooting:
- 08-troubleshooting/index.md
- Known issues: 08-troubleshooting/known-issues.md
- Appendix:
- Firmware release notes: appendix/firmware-release-notes.md
- Versions and compatibility: appendix/compatibility.md
- Hardware revisions: appendix/hardware-revisions.md
- Theory corner: appendix/theory.md
- Resources:
- Glossary: terminology.md
- Downloads and files: cad-files.md
- API reference:
- reference/index.md
- CAN frame tool and downloads: reference/can-tools.md
- CAN messages:
- reference/can/index.md
- Motion: reference/can/motion.md
- Gains and limits: reference/can/gains-and-limits.md
- Status requests: reference/can/status.md
- System: reference/can/system.md
- Parameters and buffers: reference/can/parameters.md
- Sound: reference/can/sound.md
- Gripper: reference/can/gripper.md
- UART commands:
- reference/uart/index.md
- Motion: reference/uart/motion.md
- Gains and limits: reference/uart/gains.md
- Calibration and motor parameters: reference/uart/calibration.md
- Status and utility: reference/uart/utility.md
- Gripper: reference/uart/gripper.md
- Defaults: reference/defaults.md
- Errors and LED states: reference/errors.md
- Python library: reference/python.md
- Guides:
- guides/index.md
- Python: guides/python.md
- Quadruped leg: guides/quadruped.md
- Gravity compensation: guides/gravity-compensation.md
- Bilateral teleoperation: guides/bilateral-teleoperation.md
- Support:
- Getting help: support/index.md
- Report a problem: support/report-a-problem.md
- Contributing: support/contributing.md