From 2768a7cdf37c858ecec128aa6eb68992b3686424 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Tue, 18 Jun 2019 01:49:07 +1000 Subject: [PATCH] Added some docs --- docs/forms.rst | 2 +- docs/rest.rst | 5 +++++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/forms.rst b/docs/forms.rst index a30253d51d..a9c56cf64b 100644 --- a/docs/forms.rst +++ b/docs/forms.rst @@ -42,7 +42,7 @@ Sequence of Events #. Client sends the completed form to server via POST #. Django backend handles POST request, specifically determines if the form is valid #. Return a JSON object containing status of form validity - * If the form is valid, return (at minimum) {form_valid: true}. Client will close the modal. + * If the form is valid, return (at minimum) ``{form_valid: true}``. Client will close the modal. * If the form is invalid, re-render the form and send back to the client. Process repeats At the end of this process (i.e. after successful processing of the form) the client closes the modal and runs any optional post-processes (depending on the implementation). diff --git a/docs/rest.rst b/docs/rest.rst index 73dd8d0e87..768f3d1003 100644 --- a/docs/rest.rst +++ b/docs/rest.rst @@ -35,3 +35,8 @@ API Code -------- Javascript/jQuery code for interacting with the server via the REST API can be found under ``InvenTree/static/script/InvenTree``. + +Python interface +---------------- + +A Python library for interacting with the InvenTree API is provided on `GitHub `_ \ No newline at end of file