update docs

Signed-off-by: Jess Frazelle <github@jessfraz.com>

docs/api/kittycad.AuthenticatedClient.rst

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

docs/api/kittycad.Client.rst

@@ -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

docs/api/kittycad.api.file.file_conversion_by_id.asyncio.rst

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

docs/api/kittycad.api.file.file_conversion_by_id.asyncio_detailed.rst

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

docs/api/kittycad.api.file.file_conversion_by_id.sync.rst

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

docs/api/kittycad.api.file.file_conversion_by_id.sync_detailed.rst

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

docs/api/kittycad.api.file.file_convert.asyncio.rst

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

docs/api/kittycad.api.file.file_convert.asyncio_detailed.rst

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

docs/api/kittycad.api.file.file_convert.sync.rst

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

docs/api/kittycad.api.file.file_convert.sync_detailed.rst

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

docs/api/kittycad.api.meta.meta_debug_instance.asyncio.rst

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

docs/api/kittycad.api.meta.meta_debug_instance.asyncio_detailed.rst

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

docs/api/kittycad.api.meta.meta_debug_instance.sync.rst

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

docs/api/kittycad.api.meta.meta_debug_instance.sync_detailed.rst

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

docs/api/kittycad.api.meta.meta_debug_session.asyncio.rst

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

docs/api/kittycad.api.meta.meta_debug_session.asyncio_detailed.rst

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

docs/api/kittycad.api.meta.meta_debug_session.sync.rst

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

docs/api/kittycad.api.meta.meta_debug_session.sync_detailed.rst

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

docs/api/kittycad.api.meta.ping.asyncio.rst

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

docs/api/kittycad.api.meta.ping.asyncio_detailed.rst

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

docs/api/kittycad.api.meta.ping.sync.rst

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

docs/api/kittycad.api.meta.ping.sync_detailed.rst

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

docs/api/kittycad.client.AuthenticatedClient.rst

@@ -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

docs/api/kittycad.client.Client.rst

@@ -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

docs/api/kittycad.models.AuthSession.rst

@@ -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

docs/api/kittycad.models.Environment.rst

@@ -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

docs/api/kittycad.models.ErrorMessage.rst

@@ -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

docs/api/kittycad.models.FileConversion.rst

@@ -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

docs/api/kittycad.models.FileConversionStatus.rst

@@ -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

docs/api/kittycad.models.InstanceMetadata.rst

@@ -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

docs/api/kittycad.models.Message.rst

@@ -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

docs/api/kittycad.models.ValidFileTypes.rst

@@ -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

docs/api/kittycad.models.auth_session.AuthSession.rst

@@ -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

docs/api/kittycad.models.environment.Environment.rst

@@ -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

docs/api/kittycad.models.error_message.ErrorMessage.rst

@@ -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

docs/api/kittycad.models.file_conversion.FileConversion.rst

@@ -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

docs/api/kittycad.models.file_conversion.FileConversionStatus.rst

@@ -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

docs/api/kittycad.models.file_conversion_status.FileConversionStatus.rst

@@ -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

docs/api/kittycad.models.instance_metadata.InstanceMetadata.rst

@@ -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

docs/api/kittycad.models.message.Message.rst

@@ -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

docs/api/kittycad.models.valid_file_types.ValidFileTypes.rst

@@ -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

docs/api/kittycad.types.File.rst

@@ -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

docs/api/kittycad.types.Response.rst

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

docs/conf.py

@@ -14,14 +14,15 @@ import os
 import sys
 
 
+sys.path.insert(1, os.path.dirname(os.path.abspath(__file__)))
 sys.path.append(os.path.abspath('../kittycad'))
 
 
 # -- Project information -----------------------------------------------------
 
 project = 'kittycad'
-copyright = '2021, KittyCAD Inc.'
+author = 'KittyCAD Team Members'
-author = 'KittyCAD Inc.'
+copyright = author
 
 # The full version, including alpha/beta/rc tags
 # Get the version from the poetry file.
@@ -30,8 +31,9 @@ import toml
 with open(os.path.abspath('../pyproject.toml'), 'r') as f:
     parsed_toml = toml.load(f)
     version = parsed_toml['tool']['poetry']['version']
+    version = 'v'+version
 
-release = 'v'+ version
+release = version
 
 
 # -- General configuration ---------------------------------------------------
@@ -43,9 +45,15 @@ extensions = [
     'sphinx.ext.autodoc',
     'sphinx_autodoc_typehints',
     'sphinx.ext.intersphinx',
-    'sphinx.ext.linkcode'
+    'sphinx.ext.linkcode',
+    'sphinx_automodapi.automodapi',
+    'sphinx_rtd_theme'
 ]
 
+numpydoc_show_class_members = False
+
+automodapi_inheritance_diagram = False
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -60,13 +68,20 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom themes here, relative to this directory.
+html_theme_path = [
+]
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = []
 
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'trac'
+
 # Intersphinx configuration.
 # FROM: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx
 intersphinx_mapping = {

docs/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 6bd9e2481a7ccca135a0d86b825cd8ac
+config: e70151257d05c54cbec2f82169462e1b
 tags: 645f666f9bcd5a90fca523b33c5a78b7