diff --git a/source/api/ftc_api.models.rst b/source/api/ftc_api.models.rst index 1a63559..bc045c8 100644 --- a/source/api/ftc_api.models.rst +++ b/source/api/ftc_api.models.rst @@ -92,6 +92,46 @@ ftc\_api.models.barcode\_element module :undoc-members: :show-inheritance: +ftc\_api.models.coordinate module +--------------------------------- + +.. automodule:: ftc_api.models.coordinate + :members: + :undoc-members: + :show-inheritance: + +ftc\_api.models.coordinate\_equality\_comparer module +----------------------------------------------------- + +.. automodule:: ftc_api.models.coordinate_equality_comparer + :members: + :undoc-members: + :show-inheritance: + +ftc\_api.models.coordinate\_sequence module +------------------------------------------- + +.. automodule:: ftc_api.models.coordinate_sequence + :members: + :undoc-members: + :show-inheritance: + +ftc\_api.models.coordinate\_sequence\_factory module +---------------------------------------------------- + +.. automodule:: ftc_api.models.coordinate_sequence_factory + :members: + :undoc-members: + :show-inheritance: + +ftc\_api.models.dimension module +-------------------------------- + +.. automodule:: ftc_api.models.dimension + :members: + :undoc-members: + :show-inheritance: + ftc\_api.models.endgame\_parked\_status module ---------------------------------------------- @@ -100,6 +140,14 @@ ftc\_api.models.endgame\_parked\_status module :undoc-members: :show-inheritance: +ftc\_api.models.envelope module +------------------------------- + +.. automodule:: ftc_api.models.envelope + :members: + :undoc-members: + :show-inheritance: + ftc\_api.models.event module ---------------------------- @@ -172,6 +220,30 @@ ftc\_api.models.ftc\_event\_level module :undoc-members: :show-inheritance: +ftc\_api.models.geometry module +------------------------------- + +.. automodule:: ftc_api.models.geometry + :members: + :undoc-members: + :show-inheritance: + +ftc\_api.models.geometry\_factory module +---------------------------------------- + +.. automodule:: ftc_api.models.geometry_factory + :members: + :undoc-members: + :show-inheritance: + +ftc\_api.models.geometry\_overlay module +---------------------------------------- + +.. automodule:: ftc_api.models.geometry_overlay + :members: + :undoc-members: + :show-inheritance: + ftc\_api.models.get\_v20\_season\_schedule\_event\_code\_tournament\_level\_hybrid\_tournament\_level module ------------------------------------------------------------------------------------------------------------ @@ -276,6 +348,38 @@ ftc\_api.models.match\_score\_list module :undoc-members: :show-inheritance: +ftc\_api.models.nts\_geometry\_services module +---------------------------------------------- + +.. automodule:: ftc_api.models.nts_geometry_services + :members: + :undoc-members: + :show-inheritance: + +ftc\_api.models.ogc\_geometry\_type module +------------------------------------------ + +.. automodule:: ftc_api.models.ogc_geometry_type + :members: + :undoc-members: + :show-inheritance: + +ftc\_api.models.ordinates module +-------------------------------- + +.. automodule:: ftc_api.models.ordinates + :members: + :undoc-members: + :show-inheritance: + +ftc\_api.models.point module +---------------------------- + +.. automodule:: ftc_api.models.point + :members: + :undoc-members: + :show-inheritance: + ftc\_api.models.power\_play\_alliance\_score\_breakdown module -------------------------------------------------------------- @@ -308,6 +412,22 @@ ftc\_api.models.power\_play\_single\_team\_score\_details module :undoc-members: :show-inheritance: +ftc\_api.models.precision\_model module +--------------------------------------- + +.. automodule:: ftc_api.models.precision_model + :members: + :undoc-members: + :show-inheritance: + +ftc\_api.models.precision\_models module +---------------------------------------- + +.. automodule:: ftc_api.models.precision_models + :members: + :undoc-members: + :show-inheritance: + ftc\_api.models.scheduled\_match module --------------------------------------- diff --git a/source/api/ftc_api.rst b/source/api/ftc_api.rst index 102857d..fc5b9e1 100644 --- a/source/api/ftc_api.rst +++ b/source/api/ftc_api.rst @@ -1,7 +1,5 @@ -API Docs +ftc\_api package ================ -.. important:: - Better api docs, maintained by FIRST, can be found here: https://ftc-events.firstinspires.org/api-docs/index.html Subpackages ----------- @@ -31,6 +29,14 @@ ftc\_api.errors module :undoc-members: :show-inheritance: +ftc\_api.types module +--------------------- + +.. automodule:: ftc_api.types + :members: + :undoc-members: + :show-inheritance: + Module contents --------------- diff --git a/source/conf.py b/source/conf.py index 9280785..287baf0 100644 --- a/source/conf.py +++ b/source/conf.py @@ -13,7 +13,7 @@ project = "FTC api" copyright = "2023, Ashwin Naren" author = "Ashwin Naren" -release = "0.2.0" +release = "0.4.0" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/source/quickstart.rst b/source/quickstart.rst index aca86f1..c128a70 100644 --- a/source/quickstart.rst +++ b/source/quickstart.rst @@ -26,11 +26,11 @@ Now call your endpoint and use your models: client = ftc_api.Client(username="test", authorization_key="****-****-****-****") my_data = get_v2_0_season.sync(client=client, season=2022) - print(my_data.game_name) # CENTERSTAGE + print(my_data.game_name) # CENTERSTAGE # or if you need more info (e.g. status_code) response = get_v2_0_season.sync_detailed(client=client, season=2022) - print(response.headers) # server headers - print(response.content) # raw json + print(response.headers) # server headers + print(response.content) # raw text Or do the same thing with an async version: @@ -41,11 +41,11 @@ Or do the same thing with an async version: client = ftc_api.Client(username="your username here", authorization_key="****-****-****-****") my_data = await get_v2_0_season.asyncio(client=client, season=2022) - print(my_data.game_name) # CENTERSTAGE + print(my_data.game_name) # CENTERSTAGE # or if you need more info (e.g. status_code) response = await get_v2_0_season.asyncio(client=client, season=2022) - print(response.headers) # server headers - print(response.content) # raw json + print(response.headers) # server headers + print(response.content) # raw text