Commit Graph

36 Commits

Author SHA1 Message Date
Damien ea802aa91e docs: Setup mkdocs with mkdocs-material theme
This changes the framework used to generate the klipper3d site.

Signed-off-by: Damien Martin <damlobster@gmail.com>
2021-07-27 13:15:25 -04:00
Dmitry Butyugin c483cb53cb docs: Updated adxl345 wiring image
ADXL345 3.3v and GND pins can be wired closer to the other
pins on RPi, which is often more convenient.

Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2021-05-28 11:53:16 -04:00
Arksine a93d09cdf4 docs: document bed mesh "faulty_regions"
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2021-04-10 11:16:07 -04:00
Dmitry Butyugin b6908e56aa docs: Updated measuring resonances doc on max_accel suggestions
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2021-03-20 13:24:43 -04:00
Kevin O'Connor c7dc3e78bf docs: Update CAN bus documents
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-13 11:33:56 -05:00
Dmitry Butyugin ab93ee9293 docs: Limiting max_smoothing for input shaper autocalibration
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2020-12-22 18:37:41 -05:00
Dmitry Butyugin 4a41d228eb
docs: Input Shaper and Resonances docs improvements (#3627)
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2020-12-17 17:44:46 -05:00
Dmitry Butyugin f8c4f90c04
resonance_tester: Resonance testing and input shaper auto-calibration (#3381)
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2020-10-14 20:08:10 -04:00
Dmitry Butyugin f3b980c1b2 docs: Suggested improvements to Input Shaper tuning guide
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2020-07-29 21:28:18 -04:00
Dmitry Butyugin b62a0d5db5 docs: First version of documentation for Input Shaper tuning
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2020-07-29 21:28:18 -04:00
Kevin O'Connor 3c01b60a88 docs: Update FAQ with TMC2208 "standalone" mode workaround
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2020-03-29 11:08:49 -04:00
Arksine edae40c36f docs: Update documentation to reflect bed_mesh changes
Also add new bed_mesh.md documentation.

Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2020-01-09 14:14:13 -05:00
Kevin O'Connor dabffcc22c kin_extruder: Convert pressure advance to use "weighted average"
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-12-20 12:21:58 -05:00
Kevin O'Connor 1d05a34cd7 docs: Update Kinematics.md document with "smooth pressure advance"
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-12-13 17:52:51 -05:00
Kevin O'Connor c794e11c67 docs: Update Pressure_Advance.md to use tuning tower
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-10-23 19:28:03 -04:00
Arksine a3b4543c97 skew_correction: add documentation
Signed-Off-By:  Eric Callahan <arksine.code@gmail.com>
2019-06-26 20:16:35 -04:00
Kevin O'Connor 57cf0759c0 docs: Add logos to web page
Also, move docs/index.md to docs/_layouts/home.html.  Add a
docs/_layouts/README file.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-18 22:35:35 -04:00
Kevin O'Connor 85c01d4b6a docs: Minor node changes to klipper logo
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-18 11:42:40 -04:00
Kevin O'Connor 49b18a6be7 docs: Update logo so that edges overlap
Overlapping edges reduce the effects of anti-aliasing.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-18 11:31:29 -04:00
Kevin O'Connor 9b960e63fb docs: Add a Klipper logo
Signed-off-by: Jonne Kuusela <johnedwa@gmail.com>
Signed-off-by: Michael J Shephard <michael.j.shephard@gmail.com>
Signed-off-by: Thomas Herrmann <therrmann23@gmail.com>
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-18 11:31:29 -04:00
Kevin O'Connor cb04e4c45d docs: Fix alignment of tmc2208.svg
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-04-16 11:34:45 -04:00
Eugene Krashtan c7330e07a4 stm32f0: Various fixes according to comment: (#1453)
* Copyright in log.c
* GPIO check completely removed
* generic/timer_irq added
* Change in doc section

Signed-off-by: Eugene Krashtan <eug.krashtan@gmail.com>
2019-03-28 10:21:51 -04:00
Eugene Krashtan b79db3e3d6 docs: Documentation draft for STM32F0
Signed-off-by: Eugene Krashtan <Eugene.Krashtan@opensynergy.com>
2019-03-24 12:10:11 -04:00
Kevin O'Connor 31987c7bcd docs: Add a Manual_Probe.md document
Add information on calibrating the bed on traditional printers with a
Z endstop and bed screws.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-24 00:49:47 -05:00
Kevin O'Connor 328bd89fc1 docs: Warn against using the TMC2208 in standalone mode
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-20 16:22:06 -05:00
Kevin O'Connor 57e6acbc5c docs: Add Bed_Level.md and Probe_Calibrate.md documents
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2019-02-12 13:20:32 -05:00
Kevin O'Connor 4b5db04f78 docs: Add Delta_Calibrate.md guide with "enhanced delta calibration"
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-09-25 13:48:46 -04:00
Charlie 1165c0c9c5 docs: Additional images for enhanced calibration procedure reference (#639)
Signed-off-by: Charles Galant <cgalant@cogwheel.net>
2018-09-25 13:48:46 -04:00
Kevin O'Connor 3ac9fc6e63 docs: Update documentation with iterative solver changes
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-06-20 09:26:10 -04:00
Kevin O'Connor 08444a8b89 docs: Try to make the klippy.log bug reporting more clear
Emphasize that the log file needs to be attached to the issue.
Encourage M112 to be issued on every bug report.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2018-01-21 13:08:31 -05:00
Kevin O'Connor 1bdebeaebf docs: Add an initial configuration checklist document
Provide a document with basic steps that a user can run to verify that
the pins in the configuration file are set correctly.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2017-12-26 20:54:37 -05:00
Kevin O'Connor a97e074022 docs: Kinematics document image updates
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2017-04-27 12:00:09 -04:00
Kevin O'Connor 19ffaa9ff0 docs: Reword parts of the pressure advance kinematics description.
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2017-04-19 20:48:23 -04:00
Kevin O'Connor 0f5167a407 docs: Misc image updates
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2017-04-19 19:55:50 -04:00
Kevin O'Connor db5b5f121c docs: Add initial Pressure Advance tuning document
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2017-04-19 16:02:11 -04:00
Kevin O'Connor 2cce67ad84 docs: Add initial Kinematics document
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2017-04-15 22:26:03 -04:00