Arksine
eec85f86a9
docs: add /server/history/totals to documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-22 16:51:50 -04:00
Arksine
8acd0f2728
docs: remove references to plugins and create components.md
...
Replace various notes with admonitions.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-18 17:16:36 -04:00
Arksine
d9d087b9f3
docs: add "print_start_time" and "job_id" to the metadata documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-16 20:04:25 -04:00
Arksine
dc60143ef8
docs: prepare documentation for readthedocs
...
This commit adds mkdocs.yml and modifies the existing markdown documentation so that "readthedocs" can build documentation using "mkdocs".
Included are many formatting changes and fixes to the existing documentation so that it shows up correctly when published.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-16 06:34:17 -04:00
Arksine
7e230c1c77
docs: update API documenation to reflect recent changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-15 07:03:01 -04:00
Arksine
978fcffab5
docs: fix API documentation for [octoprint_compat]
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-13 08:13:50 -05:00
Arksine
083d63568c
docs: update history api documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-13 08:12:39 -05:00
jordanruthe
9988da72c1
history: print history tracking
...
Signed-off-by: Jordan Ruthe <jordan.ruthe@gmail.com>
2021-03-11 20:09:25 -05:00
th33xitus
a111733431
docs: fix incorrect wording. 'mainsail' should correctly read 'moonraker'
...
Signed-off-by: Dominik Willner <th33xitus@gmail.com>
2021-03-05 05:17:00 -05:00
Grigi
6ba45f6e35
docs: Document simulated Octoprint API
...
Signed-off-by: Nickolas Grigoriadis <nagrigoriadis@gmail.com>
2021-03-04 20:52:55 -05:00
Arksine
46680f4cda
docs: add documentation for new machine APIs
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-04 08:52:49 -05:00
Arksine
d1dfa86081
docs: fix typos in last web_api update
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-01 15:53:35 -05:00
Arksine
dbf5f93919
docs: add more detail to the API overview in web_api.md
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-03-01 15:49:52 -05:00
Arksine
94b690c2e9
docs: add database documentation
...
Also add documentation for query string type hints.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-02-27 17:29:09 -05:00
Arksine
eb37ce767d
docs: add documentation for "/server/config" endpoint
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-02-16 11:43:31 -05:00
Arksine
81104a6618
docs: update documentation for latest changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com
2021-01-31 07:41:16 -05:00
Arksine
578ce740c5
docs: update API documentation for changes to update_manager
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-01-22 17:18:28 -05:00
Arksine
67adcfc448
docs: note update_manager API changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-01-04 08:51:41 -05:00
Arksine
4aa2a86e3b
docs: Document "notify_klippy_shutdown"
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-01-01 11:51:52 -05:00
Arksine
77c483ea0f
docs: document changes to the update_manager plugin
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-12-31 08:25:59 -05:00
Arksine
653c9190c4
docs: document "complete" field for "notifiy_update_response"
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-12-17 17:58:04 -05:00
Arksine
6403eaa0db
docs: document "update_manager" plugin
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-28 07:22:09 -05:00
Arksine
f96fb997da
docs: document API for retreiving Klipper "docs"
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-23 06:22:45 -05:00
Arksine
01a48e530f
docs: update documentation for changes to "power" plugin
...
The power APIs were never properly documented, so this adds them to web_api.md. In addition, a new "user_changes.md" document has been added to help users transition to the new plugin.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-19 15:43:24 -05:00
Arksine
2cfc5b9501
docs: update metadata documentation
...
Document the "gcode_start_byte" and "gcode_end_byte" fields.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-13 06:53:20 -05:00
Arksine
a1de70ff89
docs: document "notify_klippy_ready" websocket notfication
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-11 17:59:08 -05:00
Arksine
4b2f3a6f5f
docs: update API documentation
...
Document the new server.websocket.id method and update the documentation for the subscription APIs.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-11 11:58:28 -05:00
Arksine
73cbcb7b7e
docs: document "extended" argument for GET directory endpoint
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-02 20:18:07 -05:00
Arksine
9394bf592c
docs: Add documentation for Klipper Printer Objects
...
This documents the most useful printer objects available for query, providing the fields that a query returns and what the represent.
Also add a basic "print state monitoring" example and "bed_mesh" example to web_api.md.
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-10-26 21:25:20 -04:00
Arksine
413062f8e8
docs: Update API documentation
...
The "modified" field returned by all file manager endpoints and notifications now refers to unix time (in seconds).
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-10-25 19:50:24 -04:00
Arksine
2d77400a65
docs: update for latest API additions and changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-10-21 15:42:03 -04:00
Arksine
ac648cefcf
docs: Add new endpints to API documention
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-09-30 18:03:25 -04:00
Arksine
733cf0afac
docs: Update metadata API documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-09-09 11:32:37 -04:00
Arksine
97cb072981
docs: Add documentation for "delete_file" websocket API.
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-09-07 12:51:39 -04:00
Arksine
c122bd68e0
docs: document API changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-09-03 15:26:46 -04:00
Arksine
d59d1e5f7f
docs: document new "notify_metadata_update" notification
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-09-01 11:37:06 -04:00
Arksine
88bbd66a3b
docs: document latest API changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-08-16 19:58:15 -04:00
Arksine
a3c0f06c5f
docs: Update API documentation
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-08-16 18:08:41 -04:00
Arksine
de1a79a7ca
docs: update API documentation regarding file list notification
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-08-11 14:21:28 -04:00
Arksine
65d82a3fe8
docs: update config file APIs
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-08-05 11:17:17 -04:00
Arksine
0d29d0f811
docs: Add documentation for new file_management changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-08-01 06:05:19 -04:00
Arksine
29e7df38d0
file_manager: Add move and copy APIs
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-07-14 07:00:52 -04:00
Arksine
00d36a5a06
docs: fix incorrect method name for retreiving metadata
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-07-12 17:28:55 -04:00
Arksine
0e79b6f3f7
file_manager: add JSON-RPC "directory" APIs
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-07-04 14:33:17 -04:00
Arksine
d1c740b900
moonraker: add initial source
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-07-02 12:24:15 -04:00