diff --git a/docs/authentication-providers-ref.rst b/docs/authentication-provider-ref.rst similarity index 100% rename from docs/authentication-providers-ref.rst rename to docs/authentication-provider-ref.rst diff --git a/docs/class-reference.rst b/docs/class-reference.rst index 9f69138e..45991d3e 100644 --- a/docs/class-reference.rst +++ b/docs/class-reference.rst @@ -7,6 +7,7 @@ Class Reference account-ref appointment-group-ref assignment-ref + authentication-provider-ref avatar-ref bookmark-ref calendar-event-ref @@ -16,6 +17,7 @@ Class Reference enrollment-term-ref external-tool-ref group-ref + login-ref module-ref page-ref progress-ref diff --git a/docs/getting-started.rst b/docs/getting-started.rst index ec1329b2..034afed2 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -1,22 +1,29 @@ -Getting Started with canvasapi +Getting Started with CanvasAPI =============================== -Installing canvasapi +Installing CanvasAPI --------------------- -You can install with pip:: +You can install CanvasAPI with pip:: pip install canvasapi Usage ----- -Before using canvasapi, you'll need to instantiate a new Canvas object: +Before using CanvasAPI, you'll need to instantiate a new Canvas object: .. code:: python + # Import the Canvas class from canvasapi import Canvas + # Canvas API URL + API_URL = "https://example.com/api/v1/" + # Canvas API key + API_KEY = "p@$$w0rd" + + # Initialize a new Canvas object canvas = Canvas(API_URL, API_KEY) You can now use :code:`canvas` to make API calls. diff --git a/docs/login-ref.rst b/docs/login-ref.rst index aca211ce..9a3cf6ed 100644 --- a/docs/login-ref.rst +++ b/docs/login-ref.rst @@ -1,6 +1,6 @@ ===== Login -====== +===== .. autoclass:: canvasapi.login.Login - :members: \ No newline at end of file + :members: