ByoungSooPark/kittycad.py
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update docs

Browse Source 
Signed-off-by: Jess Frazelle <github@jessfraz.com>
This commit is contained in:
Jess Frazelle
2021-12-15 03:54:43 -08:00
parent dfa76e9462
commit 059dc0e521
284 changed files with 14864 additions and 348 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/html/_sources/api/kittycad.AuthenticatedClient.rst.txt Normal file
View File

@ -0,0 +1,17 @@
AuthenticatedClient
===================
.. currentmodule:: kittycad
.. autoclass:: AuthenticatedClient
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~AuthenticatedClient.get_headers
.. rubric:: Methods Documentation
.. automethod:: get_headers

27
docs/html/_sources/api/kittycad.Client.rst.txt Normal file
View File

@ -0,0 +1,27 @@
Client
======
.. currentmodule:: kittycad
.. autoclass:: Client
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~Client.get_cookies
~Client.get_headers
~Client.get_timeout
~Client.with_cookies
~Client.with_headers
~Client.with_timeout
.. rubric:: Methods Documentation
.. automethod:: get_cookies
.. automethod:: get_headers
.. automethod:: get_timeout
.. automethod:: with_cookies
.. automethod:: with_headers
.. automethod:: with_timeout

6
docs/html/_sources/api/kittycad.api.file.file_conversion_by_id.asyncio.rst.txt Normal file
View File

@ -0,0 +1,6 @@
asyncio
=======
.. currentmodule:: kittycad.api.file.file_conversion_by_id
.. autofunction:: asyncio

6
docs/html/_sources/api/kittycad.api.file.file_conversion_by_id.asyncio_detailed.rst.txt Normal file
View File

@ -0,0 +1,6 @@
asyncio_detailed
================
.. currentmodule:: kittycad.api.file.file_conversion_by_id
.. autofunction:: asyncio_detailed

6
docs/html/_sources/api/kittycad.api.file.file_conversion_by_id.sync.rst.txt Normal file
View File

@ -0,0 +1,6 @@
sync
====
.. currentmodule:: kittycad.api.file.file_conversion_by_id
.. autofunction:: sync

6
docs/html/_sources/api/kittycad.api.file.file_conversion_by_id.sync_detailed.rst.txt Normal file
View File

@ -0,0 +1,6 @@
sync_detailed
=============
.. currentmodule:: kittycad.api.file.file_conversion_by_id
.. autofunction:: sync_detailed

6
docs/html/_sources/api/kittycad.api.file.file_convert.asyncio.rst.txt Normal file
View File

@ -0,0 +1,6 @@
asyncio
=======
.. currentmodule:: kittycad.api.file.file_convert
.. autofunction:: asyncio

6
docs/html/_sources/api/kittycad.api.file.file_convert.asyncio_detailed.rst.txt Normal file
View File

@ -0,0 +1,6 @@
asyncio_detailed
================
.. currentmodule:: kittycad.api.file.file_convert
.. autofunction:: asyncio_detailed

6
docs/html/_sources/api/kittycad.api.file.file_convert.sync.rst.txt Normal file
View File

@ -0,0 +1,6 @@
sync
====
.. currentmodule:: kittycad.api.file.file_convert
.. autofunction:: sync

6
docs/html/_sources/api/kittycad.api.file.file_convert.sync_detailed.rst.txt Normal file
View File

@ -0,0 +1,6 @@
sync_detailed
=============
.. currentmodule:: kittycad.api.file.file_convert
.. autofunction:: sync_detailed

6
docs/html/_sources/api/kittycad.api.meta.meta_debug_instance.asyncio.rst.txt Normal file
View File

@ -0,0 +1,6 @@
asyncio
=======
.. currentmodule:: kittycad.api.meta.meta_debug_instance
.. autofunction:: asyncio

6
docs/html/_sources/api/kittycad.api.meta.meta_debug_instance.asyncio_detailed.rst.txt Normal file
View File

@ -0,0 +1,6 @@
asyncio_detailed
================
.. currentmodule:: kittycad.api.meta.meta_debug_instance
.. autofunction:: asyncio_detailed

6
docs/html/_sources/api/kittycad.api.meta.meta_debug_instance.sync.rst.txt Normal file
View File

@ -0,0 +1,6 @@
sync
====
.. currentmodule:: kittycad.api.meta.meta_debug_instance
.. autofunction:: sync

6
docs/html/_sources/api/kittycad.api.meta.meta_debug_instance.sync_detailed.rst.txt Normal file
View File

@ -0,0 +1,6 @@
sync_detailed
=============
.. currentmodule:: kittycad.api.meta.meta_debug_instance
.. autofunction:: sync_detailed

6
docs/html/_sources/api/kittycad.api.meta.meta_debug_session.asyncio.rst.txt Normal file
View File

@ -0,0 +1,6 @@
asyncio
=======
.. currentmodule:: kittycad.api.meta.meta_debug_session
.. autofunction:: asyncio

6
docs/html/_sources/api/kittycad.api.meta.meta_debug_session.asyncio_detailed.rst.txt Normal file
View File

@ -0,0 +1,6 @@
asyncio_detailed
================
.. currentmodule:: kittycad.api.meta.meta_debug_session
.. autofunction:: asyncio_detailed

6
docs/html/_sources/api/kittycad.api.meta.meta_debug_session.sync.rst.txt Normal file
View File

@ -0,0 +1,6 @@
sync
====
.. currentmodule:: kittycad.api.meta.meta_debug_session
.. autofunction:: sync

6
docs/html/_sources/api/kittycad.api.meta.meta_debug_session.sync_detailed.rst.txt Normal file
View File

@ -0,0 +1,6 @@
sync_detailed
=============
.. currentmodule:: kittycad.api.meta.meta_debug_session
.. autofunction:: sync_detailed

6
docs/html/_sources/api/kittycad.api.meta.ping.asyncio.rst.txt Normal file
View File

@ -0,0 +1,6 @@
asyncio
=======
.. currentmodule:: kittycad.api.meta.ping
.. autofunction:: asyncio

6
docs/html/_sources/api/kittycad.api.meta.ping.asyncio_detailed.rst.txt Normal file
View File

@ -0,0 +1,6 @@
asyncio_detailed
================
.. currentmodule:: kittycad.api.meta.ping
.. autofunction:: asyncio_detailed

6
docs/html/_sources/api/kittycad.api.meta.ping.sync.rst.txt Normal file
View File

@ -0,0 +1,6 @@
sync
====
.. currentmodule:: kittycad.api.meta.ping
.. autofunction:: sync

6
docs/html/_sources/api/kittycad.api.meta.ping.sync_detailed.rst.txt Normal file
View File

@ -0,0 +1,6 @@
sync_detailed
=============
.. currentmodule:: kittycad.api.meta.ping
.. autofunction:: sync_detailed

17
docs/html/_sources/api/kittycad.client.AuthenticatedClient.rst.txt Normal file
View File

@ -0,0 +1,17 @@
AuthenticatedClient
===================
.. currentmodule:: kittycad.client
.. autoclass:: AuthenticatedClient
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~AuthenticatedClient.get_headers
.. rubric:: Methods Documentation
.. automethod:: get_headers

27
docs/html/_sources/api/kittycad.client.Client.rst.txt Normal file
View File

@ -0,0 +1,27 @@
Client
======
.. currentmodule:: kittycad.client
.. autoclass:: Client
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~Client.get_cookies
~Client.get_headers
~Client.get_timeout
~Client.with_cookies
~Client.with_headers
~Client.with_timeout
.. rubric:: Methods Documentation
.. automethod:: get_cookies
.. automethod:: get_headers
.. automethod:: get_timeout
.. automethod:: with_cookies
.. automethod:: with_headers
.. automethod:: with_timeout

29
docs/html/_sources/api/kittycad.models.AuthSession.rst.txt Normal file
View File

@ -0,0 +1,29 @@
AuthSession
===========
.. currentmodule:: kittycad.models
.. autoclass:: AuthSession
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~AuthSession.additional_keys
.. rubric:: Methods Summary
.. autosummary::
~AuthSession.from_dict
~AuthSession.to_dict
.. rubric:: Attributes Documentation
.. autoattribute:: additional_keys
.. rubric:: Methods Documentation
.. automethod:: from_dict
.. automethod:: to_dict

21
docs/html/_sources/api/kittycad.models.Environment.rst.txt Normal file
View File

@ -0,0 +1,21 @@
Environment
===========
.. currentmodule:: kittycad.models
.. autoclass:: Environment
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~Environment.DEVELOPMENT
~Environment.PREVIEW
~Environment.PRODUCTION
.. rubric:: Attributes Documentation
.. autoattribute:: DEVELOPMENT
.. autoattribute:: PREVIEW
.. autoattribute:: PRODUCTION

29
docs/html/_sources/api/kittycad.models.ErrorMessage.rst.txt Normal file
View File

@ -0,0 +1,29 @@
ErrorMessage
============
.. currentmodule:: kittycad.models
.. autoclass:: ErrorMessage
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~ErrorMessage.additional_keys
.. rubric:: Methods Summary
.. autosummary::
~ErrorMessage.from_dict
~ErrorMessage.to_dict
.. rubric:: Attributes Documentation
.. autoattribute:: additional_keys
.. rubric:: Methods Documentation
.. automethod:: from_dict
.. automethod:: to_dict

29
docs/html/_sources/api/kittycad.models.FileConversion.rst.txt Normal file
View File

@ -0,0 +1,29 @@
FileConversion
==============
.. currentmodule:: kittycad.models
.. autoclass:: FileConversion
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~FileConversion.additional_keys
.. rubric:: Methods Summary
.. autosummary::
~FileConversion.from_dict
~FileConversion.to_dict
.. rubric:: Attributes Documentation
.. autoattribute:: additional_keys
.. rubric:: Methods Documentation
.. automethod:: from_dict
.. automethod:: to_dict

25
docs/html/_sources/api/kittycad.models.FileConversionStatus.rst.txt Normal file
View File

@ -0,0 +1,25 @@
FileConversionStatus
====================
.. currentmodule:: kittycad.models
.. autoclass:: FileConversionStatus
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~FileConversionStatus.COMPLETED
~FileConversionStatus.FAILED
~FileConversionStatus.IN_PROGRESS
~FileConversionStatus.QUEUED
~FileConversionStatus.UPLOADED
.. rubric:: Attributes Documentation
.. autoattribute:: COMPLETED
.. autoattribute:: FAILED
.. autoattribute:: IN_PROGRESS
.. autoattribute:: QUEUED
.. autoattribute:: UPLOADED

29
docs/html/_sources/api/kittycad.models.InstanceMetadata.rst.txt Normal file
View File

@ -0,0 +1,29 @@
InstanceMetadata
================
.. currentmodule:: kittycad.models
.. autoclass:: InstanceMetadata
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~InstanceMetadata.additional_keys
.. rubric:: Methods Summary
.. autosummary::
~InstanceMetadata.from_dict
~InstanceMetadata.to_dict
.. rubric:: Attributes Documentation
.. autoattribute:: additional_keys
.. rubric:: Methods Documentation
.. automethod:: from_dict
.. automethod:: to_dict

29
docs/html/_sources/api/kittycad.models.Message.rst.txt Normal file
View File

@ -0,0 +1,29 @@
Message
=======
.. currentmodule:: kittycad.models
.. autoclass:: Message
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~Message.additional_keys
.. rubric:: Methods Summary
.. autosummary::
~Message.from_dict
~Message.to_dict
.. rubric:: Attributes Documentation
.. autoattribute:: additional_keys
.. rubric:: Methods Documentation
.. automethod:: from_dict
.. automethod:: to_dict

25
docs/html/_sources/api/kittycad.models.ValidFileTypes.rst.txt Normal file
View File

@ -0,0 +1,25 @@
ValidFileTypes
==============
.. currentmodule:: kittycad.models
.. autoclass:: ValidFileTypes
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~ValidFileTypes.DWG
~ValidFileTypes.DXF
~ValidFileTypes.OBJ
~ValidFileTypes.STEP
~ValidFileTypes.STL
.. rubric:: Attributes Documentation
.. autoattribute:: DWG
.. autoattribute:: DXF
.. autoattribute:: OBJ
.. autoattribute:: STEP
.. autoattribute:: STL

29
docs/html/_sources/api/kittycad.models.auth_session.AuthSession.rst.txt Normal file
View File

@ -0,0 +1,29 @@
AuthSession
===========
.. currentmodule:: kittycad.models.auth_session
.. autoclass:: AuthSession
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~AuthSession.additional_keys
.. rubric:: Methods Summary
.. autosummary::
~AuthSession.from_dict
~AuthSession.to_dict
.. rubric:: Attributes Documentation
.. autoattribute:: additional_keys
.. rubric:: Methods Documentation
.. automethod:: from_dict
.. automethod:: to_dict

21
docs/html/_sources/api/kittycad.models.environment.Environment.rst.txt Normal file
View File

@ -0,0 +1,21 @@
Environment
===========
.. currentmodule:: kittycad.models.environment
.. autoclass:: Environment
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~Environment.DEVELOPMENT
~Environment.PREVIEW
~Environment.PRODUCTION
.. rubric:: Attributes Documentation
.. autoattribute:: DEVELOPMENT
.. autoattribute:: PREVIEW
.. autoattribute:: PRODUCTION

29
docs/html/_sources/api/kittycad.models.error_message.ErrorMessage.rst.txt Normal file
View File

@ -0,0 +1,29 @@
ErrorMessage
============
.. currentmodule:: kittycad.models.error_message
.. autoclass:: ErrorMessage
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~ErrorMessage.additional_keys
.. rubric:: Methods Summary
.. autosummary::
~ErrorMessage.from_dict
~ErrorMessage.to_dict
.. rubric:: Attributes Documentation
.. autoattribute:: additional_keys
.. rubric:: Methods Documentation
.. automethod:: from_dict
.. automethod:: to_dict

29
docs/html/_sources/api/kittycad.models.file_conversion.FileConversion.rst.txt Normal file
View File

@ -0,0 +1,29 @@
FileConversion
==============
.. currentmodule:: kittycad.models.file_conversion
.. autoclass:: FileConversion
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~FileConversion.additional_keys
.. rubric:: Methods Summary
.. autosummary::
~FileConversion.from_dict
~FileConversion.to_dict
.. rubric:: Attributes Documentation
.. autoattribute:: additional_keys
.. rubric:: Methods Documentation
.. automethod:: from_dict
.. automethod:: to_dict

25
docs/html/_sources/api/kittycad.models.file_conversion.FileConversionStatus.rst.txt Normal file
View File

@ -0,0 +1,25 @@
FileConversionStatus
====================
.. currentmodule:: kittycad.models.file_conversion
.. autoclass:: FileConversionStatus
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~FileConversionStatus.COMPLETED
~FileConversionStatus.FAILED
~FileConversionStatus.IN_PROGRESS
~FileConversionStatus.QUEUED
~FileConversionStatus.UPLOADED
.. rubric:: Attributes Documentation
.. autoattribute:: COMPLETED
.. autoattribute:: FAILED
.. autoattribute:: IN_PROGRESS
.. autoattribute:: QUEUED
.. autoattribute:: UPLOADED

25
docs/html/_sources/api/kittycad.models.file_conversion_status.FileConversionStatus.rst.txt Normal file
View File

@ -0,0 +1,25 @@
FileConversionStatus
====================
.. currentmodule:: kittycad.models.file_conversion_status
.. autoclass:: FileConversionStatus
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~FileConversionStatus.COMPLETED
~FileConversionStatus.FAILED
~FileConversionStatus.IN_PROGRESS
~FileConversionStatus.QUEUED
~FileConversionStatus.UPLOADED
.. rubric:: Attributes Documentation
.. autoattribute:: COMPLETED
.. autoattribute:: FAILED
.. autoattribute:: IN_PROGRESS
.. autoattribute:: QUEUED
.. autoattribute:: UPLOADED

29
docs/html/_sources/api/kittycad.models.instance_metadata.InstanceMetadata.rst.txt Normal file
View File

@ -0,0 +1,29 @@
InstanceMetadata
================
.. currentmodule:: kittycad.models.instance_metadata
.. autoclass:: InstanceMetadata
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~InstanceMetadata.additional_keys
.. rubric:: Methods Summary
.. autosummary::
~InstanceMetadata.from_dict
~InstanceMetadata.to_dict
.. rubric:: Attributes Documentation
.. autoattribute:: additional_keys
.. rubric:: Methods Documentation
.. automethod:: from_dict
.. automethod:: to_dict

29
docs/html/_sources/api/kittycad.models.message.Message.rst.txt Normal file
View File

@ -0,0 +1,29 @@
Message
=======
.. currentmodule:: kittycad.models.message
.. autoclass:: Message
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~Message.additional_keys
.. rubric:: Methods Summary
.. autosummary::
~Message.from_dict
~Message.to_dict
.. rubric:: Attributes Documentation
.. autoattribute:: additional_keys
.. rubric:: Methods Documentation
.. automethod:: from_dict
.. automethod:: to_dict

25
docs/html/_sources/api/kittycad.models.valid_file_types.ValidFileTypes.rst.txt Normal file
View File

@ -0,0 +1,25 @@
ValidFileTypes
==============
.. currentmodule:: kittycad.models.valid_file_types
.. autoclass:: ValidFileTypes
:show-inheritance:
.. rubric:: Attributes Summary
.. autosummary::
~ValidFileTypes.DWG
~ValidFileTypes.DXF
~ValidFileTypes.OBJ
~ValidFileTypes.STEP
~ValidFileTypes.STL
.. rubric:: Attributes Documentation
.. autoattribute:: DWG
.. autoattribute:: DXF
.. autoattribute:: OBJ
.. autoattribute:: STEP
.. autoattribute:: STL

17
docs/html/_sources/api/kittycad.types.File.rst.txt Normal file
View File

@ -0,0 +1,17 @@
File
====
.. currentmodule:: kittycad.types
.. autoclass:: File
:show-inheritance:
.. rubric:: Methods Summary
.. autosummary::
~File.to_tuple
.. rubric:: Methods Documentation
.. automethod:: to_tuple

7
docs/html/_sources/api/kittycad.types.Response.rst.txt Normal file
View File

@ -0,0 +1,7 @@
Response
========
.. currentmodule:: kittycad.types
.. autoclass:: Response
:show-inheritance: