aboutsummaryrefslogtreecommitdiffstats
path: root/docs/_klipper3d
Commit message (Collapse)AuthorAgeFilesLines
* mkdocs-requirements: Update to Jinja 3.1.6Kevin O'Connor2025-04-031-1/+1
| | | | | | | | A security vulnerability was found in Jinja 3.1.5 . The software is not impacted by this vulnerability, but there is no harm in updating to the fixed version. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix typo in docs generation documentationRussell Cloran2025-04-011-2/+2
| | | | Signed-off-by: Russell Cloran <rcloran@gmail.com>
* load_cell: Load cell gram scale (#6729)Gareth Farrington2025-03-201-0/+1
| | | | | | | | | | | | | | * Add gram scale features to load_cell * Convert sensor counts to grams and make this available via unix socket and object status * Basic GCodes for tearing and reading the load cell * Guided Calibration * Diagnostic gcode to check the health of the load cell * Update load_cell Documentation * Add API server load_cell/dump_force endpoint * Update [load_cell] config with calibration fields * Add G-Code commands for working with load cells * Add status reference for load_cell objects Signed-off-by: Gareth Farrington <gareth@waves.ky>
* mkdocs-requirements: Update jinja dependency to 3.1.5Kevin O'Connor2025-02-021-1/+1
| | | | | | | | It appears there was a security vulnerability in Jinja v3.1.4 . The Klipper docs are not impacted by this vulnerability, but it's simple enough to increment the version to avoid warnings. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Installation.md (#6650)JamesH19782024-08-081-1/+3
| | | | | | | Added links for Fluidd/Mainsail/Octoprint Added references to overview.md and mkdocs.yml and spelling errors. Signed-off-by: James Hartley <james@hartleyns.com>
* mkdocs: Update idKevin O'Connor2024-06-301-1/+1
| | | | | | The Google UA ids are deprecated - update to assigned GA4 id. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update jinja2 requirement in mkdocs-requirements.txtKevin O'Connor2024-05-151-1/+1
| | | | | | | | Update the jinja2 version to suppress security warnings. Klipper is not impacted by the vulnerability, but it is harmless to update the version. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a new Eddy_Probe.md documentKevin O'Connor2024-04-091-0/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update to mkdocs to use latest jinj2 versionKevin O'Connor2024-01-181-2/+2
| | | | | | | | There is a jinja2 security advisory on the current Jinja2 version. Klipper is not impacted by this advisory (as it does not run jinja2 on any untrusted data), but there is no harm in updating. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: add info about requesting bootloadersAaron B. Haun2023-10-121-0/+1
| | | | Signed-off-by: Aaron B. Haun <aaron@haun.guru>
* axis_twist_compensation: Add X twist compensation module (#6149)Philippe Daouadi2023-08-011-0/+1
| | | | | | | | | | | | Implements AxisTwistCompensation, and Calibrater Supports calibration of z-offsets caused by x gantry twist Modify PrinterProbe._probe function to check if the probed z value should be adjusted based on axis_twist_compensation's configuration Add documentation for [axis_twist_compensation] module Signed-off-by: Jeremy Tan <jeremytkw98@gmail.com>
* docs: Add new CANBUS_Troubleshooting.md documentKevin O'Connor2023-05-301-0/+1
| | | | | | Add information on troubleshooting canbus connections. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add a Sponsors.md fileKevin O'Connor2022-07-161-0/+1
| | | | | | Add a documentation page with information on how to support Klipper. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* mkdocs-requirements: Force markdown==3.3.7Kevin O'Connor2022-07-161-0/+1
| | | | | | | A new release of markdown (v3.4.1) breaks the website deployment scripts. Force the existing version. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* mkdocs: Replace TOC in TranslationsYifei Ding2022-06-031-0/+20
| | | | Signed-off-by: Yifei Ding<yifeiding@protonmail.com>
* docs: add exclude_object documentationFrank Tackitt2022-06-031-0/+1
| | | | | | | Also include sample macros to add M486 compatibility. Signed-off-by: Franklyn Tackitt <git@frank.af> Co-authored-by: Troy Jacobson <troy.d.jacobson@gmail.com>
* _klipper3d: Specify mkdocs language config optionsYifei Ding2022-04-062-2/+14
| | | | | Signed-off-by: Yifei Ding <yifeiding@protonmail.com> Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* _klipper3d: New language translation deploymentYifei Ding2022-04-063-1/+78
| | | | | Signed-off-by: Yifei Ding <yifeiding@protonmail.com> Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* _klipper3d: Remove translation stubsKevin O'Connor2022-04-064-38/+0
| | | | | | | | Support for language translations on the klipper3d.org site was disabled in commit c067d4df. Fully remove the support in this commit. This is in preparation for an alternate implementation. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add explicit Jinja2 prerequisite to mkdocs-requirements.txtKevin O'Connor2022-03-291-0/+1
| | | | | | Avoid build failures by adding explicit Jinja2 version. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Change the klipper3d.org "language selection" iconKevin O'Connor2022-02-161-0/+1
| | | | | | | | | Change from the "material translate icon" to the "material language icon" for the language selection icon. (The "material language icon" is an alias for the "material web icon" and it seems we can't use the alias, so we directly set the icon to "material/web".) Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix Translation Support Script (#5263)Yifei Ding2022-02-141-2/+2
| | | Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
* docs: Fixes for mkdocs translation supportKevin O'Connor2022-02-143-2/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Mkdocs i18n support (#5072)Yifei Ding2022-02-144-7/+43
| | | Signed-off-by: Yifei DIng <yifeiding@protonmail.com>
* docs: Upgrade to mkdocs-material v8.1.3Kevin O'Connor2021-12-311-1/+1
| | | | | | This version seems to fix an error in text highlighting during search. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Remove mkdocs-section-index from mkdocs-requirements.txtKevin O'Connor2021-12-311-1/+0
| | | | | | | Commit bd0185cf removed the section-index plugin. Remove it from the build requirements as well. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Rename DocumentsYifei Ding2021-11-221-3/+3
| | | | Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
* docs: Update mkdocs-requirements.txtKevin O'Connor2021-10-151-1/+1
| | | | | | | | Update mkdocs to v1.2.3 to avoid a github "dependabot" warning for CVE-2021-40978. (The CVE doesn't impact the klipper3d.org site, but no harm in updating.) Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update documentation with new klipper github URLKevin O'Connor2021-09-231-2/+2
| | | | | | | | The main code repository moved from https://github.com/KevinOConnor/klipper.git to https://github.com/Klipper3d/klipper.git . Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* mcu: Support multi-mcu homingKevin O'Connor2021-08-281-2/+3
| | | | | | | Support endstops and probes attached to a different micro-controller than their associated steppers. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Don't use section-index plugin during klipper3d.org site generationKevin O'Connor2021-08-171-15/+12
| | | | | | | The section-index plugin can cause some confusing navigation. Use the simpler site navigation for now. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* mkdocs_hooks: Improve check for not in a listKevin O'Connor2021-08-021-1/+1
| | | | | | | | Look for lines that don't start with a list and don't start with a space to check for the end of a list. This fixes the rendering of the list in BLTouch.md . Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* mkdocs_hooks: Add some comments to the scriptKevin O'Connor2021-08-021-0/+10
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* _klipper3d: Add additional comments to mkdocs.ymlKevin O'Connor2021-08-021-29/+34
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* klipper3d: links to anchors not working with SafariDamien2021-07-281-1/+0
| | | | | Solves issue #4538 Signed-off-by: Damien Martin <damlobster@gmail.com>
* _klipper3d: Set use_directory_urls to FalseKevin O'Connor2021-07-271-0/+1
| | | | | | | Restore old link behavior - each document file will have a single html file ending in the ".html" suffix. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* _klipper3d: Move mkdocs.yml to docs/_klipper3dKevin O'Connor2021-07-271-0/+122
| | | | | | Reported by @damlobster . Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* _klipper3d: Add comments to files in this directoryKevin O'Connor2021-07-274-0/+9
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* _klipper3d: Add trailing newline to extra.cssKevin O'Connor2021-07-271-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: make mkdocs_hooks.transform more robustDamien Martin2021-07-271-10/+23
| | | | | | | - Keeps the markdown inside the code blocks as is - Logs the modified lines (mkdocs serve —verbose) Signed-off-by: Damien Martin <damlobster@gmail.com>
* docs: Setup mkdocs with mkdocs-material themeDamien2021-07-273-0/+41
This changes the framework used to generate the klipper3d site. Signed-off-by: Damien Martin <damlobster@gmail.com>
generated by cgit v1.2.3-70-g09d2 (git 2.50.1) at 2025-09-02 10:07:07 +0000