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
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
81104a6618
docs: update documentation for latest changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com
2021-01-31 07:41:16 -05:00
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
67adcfc448
docs: note update_manager API changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-01-04 08:51:41 -05:00
4aa2a86e3b
docs: Document "notify_klippy_shutdown"
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2021-01-01 11:51:52 -05:00
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
6403eaa0db
docs: document "update_manager" plugin
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-11-28 07:22:09 -05:00
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
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
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
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
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
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
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
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
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
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
c122bd68e0
docs: document API changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-09-03 15:26:46 -04:00
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
88bbd66a3b
docs: document latest API changes
...
Signed-off-by: Eric Callahan <arksine.code@gmail.com>
2020-08-16 19:58:15 -04:00
Arksine