Commit Graph

33 Commits

Author SHA1 Message Date
Kevin O'Connor 94719fe327 docs: Update to mkdocs to use latest jinj2 version
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>
2024-01-18 13:36:17 -05:00
Aaron B. Haun ecc9bbf52a docs: add info about requesting bootloaders
Signed-off-by: Aaron B. Haun <aaron@haun.guru>
2023-10-12 20:53:31 -04:00
Philippe Daouadi 039daecb4f
axis_twist_compensation: Add X twist compensation module (#6149)
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>
2023-08-01 13:08:53 -04:00
Kevin O'Connor 14ff50c94d docs: Add new CANBUS_Troubleshooting.md document
Add information on troubleshooting canbus connections.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2023-05-30 20:16:28 -04:00
Kevin O'Connor 2f9fe49cb8 docs: Add a Sponsors.md file
Add a documentation page with information on how to support Klipper.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2022-07-16 10:48:10 -04:00
Kevin O'Connor 06022b305f mkdocs-requirements: Force markdown==3.3.7
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>
2022-07-16 10:43:53 -04:00
Yifei Ding 9047702a00 mkdocs: Replace TOC in Translations
Signed-off-by: Yifei Ding<yifeiding@protonmail.com>
2022-06-03 19:14:13 -04:00
Frank Tackitt 638cd4d781 docs: add exclude_object documentation
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>
2022-06-03 14:12:04 -04:00
Yifei Ding 61792e3e31 _klipper3d: Specify mkdocs language config options
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2022-04-06 19:04:48 -04:00
Yifei Ding b35b6cb10b _klipper3d: New language translation deployment
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2022-04-06 19:04:48 -04:00
Kevin O'Connor 444d209cce _klipper3d: Remove translation stubs
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>
2022-04-06 19:04:48 -04:00
Kevin O'Connor 3340bb2ffd docs: Add explicit Jinja2 prerequisite to mkdocs-requirements.txt
Avoid build failures by adding explicit Jinja2 version.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2022-03-29 20:40:48 -04:00
Kevin O'Connor 131cca2b51 docs: Change the klipper3d.org "language selection" icon
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>
2022-02-16 12:09:09 -05:00
Yifei Ding 646bb02355
docs: Fix Translation Support Script (#5263)
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
2022-02-14 14:13:12 -05:00
Kevin O'Connor c78676ff5f docs: Fixes for mkdocs translation support
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2022-02-14 11:35:07 -05:00
Yifei Ding 61329049a6
docs: Mkdocs i18n support (#5072)
Signed-off-by: Yifei DIng <yifeiding@protonmail.com>
2022-02-14 11:29:41 -05:00
Kevin O'Connor 608cd38de5 docs: Upgrade to mkdocs-material v8.1.3
This version seems to fix an error in text highlighting during search.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-12-31 11:22:44 -05:00
Kevin O'Connor 7e4dff3b37 docs: Remove mkdocs-section-index from mkdocs-requirements.txt
Commit bd0185cf removed the section-index plugin.  Remove it from the
build requirements as well.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-12-31 11:22:44 -05:00
Yifei Ding a1af78cb83 docs: Rename Documents
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
2021-11-22 21:03:32 -05:00
Kevin O'Connor 9a0bcf21cf docs: Update mkdocs-requirements.txt
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>
2021-10-15 12:24:10 -04:00
Kevin O'Connor 44e2c630b3 docs: Update documentation with new klipper github URL
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>
2021-09-23 19:37:27 -04:00
Kevin O'Connor 950477849d mcu: Support multi-mcu homing
Support endstops and probes attached to a different micro-controller
than their associated steppers.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-28 16:08:57 -04:00
Kevin O'Connor bd0185cf75 docs: Don't use section-index plugin during klipper3d.org site generation
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>
2021-08-17 19:39:23 -04:00
Kevin O'Connor 3176150050 mkdocs_hooks: Improve check for not in a list
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>
2021-08-02 16:14:54 -04:00
Kevin O'Connor b8f6b90467 mkdocs_hooks: Add some comments to the script
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-02 15:48:51 -04:00
Kevin O'Connor b837a344c1 _klipper3d: Add additional comments to mkdocs.yml
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-02 14:05:25 -04:00
Damien be122411b5 klipper3d: links to anchors not working with Safari
Solves issue #4538

Signed-off-by: Damien Martin <damlobster@gmail.com>
2021-07-28 09:26:08 -04:00
Kevin O'Connor a17c2ae397 _klipper3d: Set use_directory_urls to False
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>
2021-07-27 18:58:08 -04:00
Kevin O'Connor ba16c0f1aa _klipper3d: Move mkdocs.yml to docs/_klipper3d
Reported by @damlobster .

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-27 17:10:59 -04:00
Kevin O'Connor 9c6b4d1bf4 _klipper3d: Add comments to files in this directory
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-27 13:49:06 -04:00
Kevin O'Connor bca64895e4 _klipper3d: Add trailing newline to extra.css
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-27 13:34:40 -04:00
Damien Martin afca515e2c docs: make mkdocs_hooks.transform more robust
- Keeps the markdown inside the code blocks as is
- Logs the modified lines (mkdocs serve —verbose)

Signed-off-by: Damien Martin <damlobster@gmail.com>
2021-07-27 13:15:25 -04:00
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