Eric Callahan
6ec37fdacc
docs: add new doc structure for peripheral requests
...
This adds a new structure for API documentation, making each
aspect visible and uniform. The parameters, response, and
schema are collapsible, allowing for easier navigation.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-02-01 10:28:20 -05:00
Eric Callahan
931e88b9f0
docs: move to material theme
...
The material theme is more feature complete and flexibile,
providing better documentation for APIs and such. This
commit is just the initial move. The documents are functional,
but the layout and color schemes are subject to change.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-02-01 10:28:19 -05:00
Eric Callahan
948b842351
docs: add peripheral API documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-02-01 10:28:14 -05:00
Eric Callahan
61ea86033a
docs: update changelog and configuration docs
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-01-28 06:12:13 -05:00
Eric Callahan
f44fc4b85b
docs: update changelog and add note about trusted domains
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-01-22 12:42:25 -05:00
Eric Callahan
3d44c51613
docs: minor spelling fixes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-01-21 13:50:30 -05:00
Eric Callahan
d10ce8772d
docs: add zip type documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-01-21 08:24:06 -05:00
Eric Callahan
b620ebbc29
docs: document status endpoint and notification
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-01-21 08:24:03 -05:00
Eric Callahan
045075c396
docs: update spoolman proxy documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2024-01-21 08:24:01 -05:00
Eric Callahan
c226e9c1e4
docs: note history changes in changelog
...
Singed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-12-27 07:48:20 -05:00
Eric Callahan
ee0c641b08
docs: update webcam documentation
...
Add tables specifying known values for the "icon"
and "service" options.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-12-24 19:44:16 -05:00
Eric Callahan
cc5dea716b
docs: note gpio and button behavior changes user_changes.md
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-12-24 07:53:00 -05:00
Eric Callahan
06a3f932ba
docs: update gpio documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-12-22 18:19:59 -05:00
wollew
7fc571643d
power: enable HTTP port option for Zigbee/Hue devices
...
Signed-off-by: Wolfgang Miller-Reichling <wolfgang+github@miller-reichling.de>
2023-12-22 18:19:05 -05:00
Eric Callahan
088d9ee59a
docs: update power documentation
...
Note that currently only Gen 1 shelly devices are supported.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-12-22 16:53:52 -05:00
Eric Callahan
90e2ab6fcf
docs: add JSON-RPC over HTTP documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-12-22 16:51:57 -05:00
Eric Callahan
42357891a3
docs: add "check_klipper_config_path" documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-12-16 15:31:35 -05:00
Eric Callahan
e3cf9b2aa9
docs: note changes to bound service init
...
When "initial_state" is configured, bound services will be
initialzed based on that state...stopped if the state is
"off", started if its "on.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-11-15 18:09:57 -05:00
Eric Callahan
588454ffee
docs: document agent remote method registration
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-11-07 14:49:19 -05:00
docgalaxyblock
2e27b073c9
docs: add Domoticz power device documentation
...
Signed-off-by: Olivier Berthomme <olivier@berthomme.fr>
2023-11-05 10:54:48 -05:00
docgalaxyblock
b63ca44094
docs: updated prebuild images config path note from `~/klipper_config` to `~/printer_data`
...
MainsailOS loads the moonraker.conf from `~/printer_data/config/`
Source:
[MainsailOS moonraker](https://github.com/mainsail-crew/MainsailOS/tree/develop/src/modules/moonraker/filesystem/home/pi )
[MainsailOS klipper](https://github.com/mainsail-crew/MainsailOS/blob/develop/src/modules/klipper/config#L28 )
Signed-off-by: Joshua Schlicker <potter-91@web.de>
2023-11-03 17:53:14 -04:00
Daisuke Sato
17ffb4455e
docs: fix typos in docs
...
Signed-off-by: Daisuke Sato <tiryoh@gmail.com>
2023-10-24 08:17:40 -04:00
Eric Callahan
9785387867
docs: update linting guidelines
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-10-07 10:42:34 -04:00
Eric Callahan
a39dbeadac
docs: update changelog
...
Note performance improvement for Raspberry Pi CPU
throttle detection.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-10-07 07:40:42 -04:00
Eric Callahan
82dd2f3c1f
docs: add speedups documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-10-07 07:40:40 -04:00
Eric Callahan
3ccf02c156
docs: update changelog
...
Note the fix for parsing inline comments.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-10-06 18:20:19 -04:00
Eric Callahan
c50e61a25b
docs: update and clarify inline comment rules
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-10-06 12:35:43 -04:00
Eric Callahan
a222ff0042
docs: update webcam API documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-10-03 07:41:32 -04:00
Eric Callahan
d98f11b98e
docs: note route_prefix option
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-09-20 12:42:30 -04:00
Eric Callahan
fe120952ee
docs: note "include_monitors" arg for the temperature store
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-08-03 07:57:36 -04:00
Eric Callahan
797c62389d
docs: add links to Klipper's status reference
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-07-31 16:44:23 -04:00
Eric Callahan
8adda52df1
docs: update changelog
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-07-31 16:42:46 -04:00
Eric Callahan
937c766ded
docs: add environment variable documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-07-26 07:29:41 -04:00
Eric Callahan
aebcd00f61
docs: note the anomalies field for update status
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-07-24 18:12:12 -04:00
Eric Callahan
821f3c5161
docs: note unixsocket commandline option
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-07-22 06:17:57 -04:00
Eric Callahan
fdc3e0eb0b
docs: document changes to update_manager
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-07-21 06:11:00 -04:00
Eric Callahan
a7e154fbe4
changelog: note job_queue bugfix
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-06-29 12:30:59 -04:00
Eric Callahan
5d8422ec52
docs: correct spoolman API documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-06-27 16:25:51 -04:00
Eric Callahan
07544718fa
docs: note the 'spoolman_set_active_spool' remote method
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-06-26 18:10:33 -04:00
Eric Callahan
56499f9269
docs: note update_manager config changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-06-26 16:48:48 -04:00
Eric Callahan
09c29eab23
docs: minor spoolman updates
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-06-26 16:32:49 -04:00
Donkie
7172531386
docs: Fixed parmams typo
...
Signed-off-by: Daniel Hultgren <daniel.cf.hultgren@gmail.com>
2023-06-26 16:24:41 -04:00
Donkie
e6b3b8ba48
docs: Added section for spoolman
...
Signed-off-by: Daniel Hultgren <daniel.cf.hultgren@gmail.com>
2023-06-26 16:24:41 -04:00
Eric Callahan
2b98792657
docs: add zeroconf changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-06-25 07:02:12 -04:00
Eric Callahan
0f4276d9b0
docs: document update_manager changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-06-20 11:59:42 -04:00
quarkvalk
aa0f89c2a4
docs: fix JSON-RPC typo
...
Removed trailing comma in the JSON-RPC request example for
"Get Server Config", as that will raise an error.
Signed-off-by: Carl Rothe (carlrothe@gmail.com )
2023-06-08 07:16:28 -04:00
dependabot[bot]
348b7f521f
build(deps): bump pymdown-extensions from 9.9.2 to 10.0 in /docs
...
Bumps [pymdown-extensions](https://github.com/facelessuser/pymdown-extensions ) from 9.9.2 to 10.0.
- [Release notes](https://github.com/facelessuser/pymdown-extensions/releases )
- [Commits](https://github.com/facelessuser/pymdown-extensions/compare/9.9.2...10.0 )
---
updated-dependencies:
- dependency-name: pymdown-extensions
dependency-type: direct:production
...
Signed-off-by: dependabot[bot] <support@github.com>
2023-05-25 16:10:24 -04:00
Chris Thornton
b21f177e95
notifier: Add `body_format` as an option
...
This lets you format the messages through apprise a little nicer
Signed-off-by: Chris Thornton <cwgthornton@gmail.com>
2023-05-07 05:59:43 -04:00
Eric Callahan
6c7dfe5921
docs: add new fields to webcam documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2023-04-23 07:30:08 -04:00
Eric Callahan
eff090170c
docs: update power configuration documentation
...
Signed-off-by: Eric Callaham <arksine.code@gmail.com>
2023-04-14 07:43:29 -04:00