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

updates

Browse Source 
Signed-off-by: Jess Frazelle <github@jessfraz.com>
This commit is contained in:
Jess Frazelle
2021-12-15 03:03:01 -08:00
parent abf4ce8e52
commit dfa76e9462
49 changed files with 16296 additions and 1475 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
.github/workflows/build-test.yml vendored
View File

@ -29,20 +29,19 @@ jobs:
shell: bash
run: |
pip install \
flake8 \
poetry \
pytest
poetry
- name: Build
shell: bash
run: |
poetry install
poetry build
- name: Lint with flake8
shell: bash
run: |
# stop the build if there are Python syntax errors or undefined names
flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
poetry run flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
# exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
poetry run flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics

7
.github/workflows/generate-docs.yml vendored
View File

@ -27,6 +27,9 @@ jobs:
- name: Install dependencies
shell: bash
run: |
sudo apt update && sudo apt install -y \
enchant-2 \
--no-install-recommends
pip install \
poetry
@ -40,10 +43,8 @@ jobs:
run: |
rm -rf docs/html
poetry install
poetry run sphinx-build -b html docs/ docs/html/
for f in `poetry run python -m pydoc -k kittycad | awk '{ print $1}'`; do poetry run python -m pydoc -w $f; done
mkdir -p docs/html
mv *.html docs/html/
mv docs/html/kittycad.html docs/html/index.html
- name: Check for modified files
id: git-check

98
docs/conf.py Normal file
View File

@ -0,0 +1,98 @@
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
#
import os
import sys
sys.path.append(os.path.abspath('../kittycad'))
# -- Project information -----------------------------------------------------
project = 'kittycad'
copyright = '2021, KittyCAD Inc.'
author = 'KittyCAD Inc.'
# The full version, including alpha/beta/rc tags
# Get the version from the poetry file.
import toml
with open(os.path.abspath('../pyproject.toml'), 'r') as f:
parsed_toml = toml.load(f)
version = parsed_toml['tool']['poetry']['version']
release = 'v'+ version
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx_autodoc_typehints',
'sphinx.ext.intersphinx',
'sphinx.ext.linkcode'
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
# 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 = []
# Intersphinx configuration.
# FROM: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx
intersphinx_mapping = {
'python': ('https://python.readthedocs.io/en/latest/', None),
}
# This is a function linkcode_resolve(domain, info), which should return the URL
# to source code corresponding to the object in given domain with given information.
# FROM: https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html
def linkcode_resolve(domain, info):
if domain != 'py':
return None
if not info['module']:
return None
filename = info['module'].replace('.', '/')
return "https://github.com/kittycad/kittycad.py/%s.py" % filename
# Spell checker.
try:
import enchant # noqa # pylint: disable=unused-import
except ImportError as ex:
print("enchant module import failed:\n"
"{0}\n"
"Spell checking disabled.".format(ex),
file=sys.stderr)
else:
extensions.append('sphinxcontrib.spelling')
spelling_show_suggestions = True

4
docs/html/.buildinfo Normal file
View File

@ -0,0 +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
tags: 645f666f9bcd5a90fca523b33c5a78b7

BIN
docs/html/.doctrees/environment.pickle Normal file
View File

Binary file not shown.

BIN
docs/html/.doctrees/index.doctree Normal file
View File

Binary file not shown.

20
docs/html/_sources/index.rst.txt Normal file
View File

@ -0,0 +1,20 @@
.. kittycad documentation master file, created by
sphinx-quickstart on Wed Dec 15 10:15:30 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to kittycad's documentation!
====================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

701
docs/html/_static/alabaster.css Normal file
View File

@ -0,0 +1,701 @@
@import url("basic.css");
/* -- page layout ----------------------------------------------------------- */
body {
font-family: Georgia, serif;
font-size: 17px;
background-color: #fff;
color: #000;
margin: 0;
padding: 0;
}
div.document {
width: 940px;
margin: 30px auto 0 auto;
}
div.documentwrapper {
float: left;
width: 100%;
}
div.bodywrapper {
margin: 0 0 0 220px;
}
div.sphinxsidebar {
width: 220px;
font-size: 14px;
line-height: 1.5;
}
hr {
border: 1px solid #B1B4B6;
}
div.body {
background-color: #fff;
color: #3E4349;
padding: 0 30px 0 30px;
}
div.body > .section {
text-align: left;
}
div.footer {
width: 940px;
margin: 20px auto 30px auto;
font-size: 14px;
color: #888;
text-align: right;
}
div.footer a {
color: #888;
}
p.caption {
font-family: inherit;
font-size: inherit;
}
div.relations {
display: none;
}
div.sphinxsidebar a {
color: #444;
text-decoration: none;
border-bottom: 1px dotted #999;
}
div.sphinxsidebar a:hover {
border-bottom: 1px solid #999;
}
div.sphinxsidebarwrapper {
padding: 18px 10px;
}
div.sphinxsidebarwrapper p.logo {
padding: 0;
margin: -10px 0 0 0px;
text-align: center;
}
div.sphinxsidebarwrapper h1.logo {
margin-top: -10px;
text-align: center;
margin-bottom: 5px;
text-align: left;
}
div.sphinxsidebarwrapper h1.logo-name {
margin-top: 0px;
}
div.sphinxsidebarwrapper p.blurb {
margin-top: 0;
font-style: normal;
}
div.sphinxsidebar h3,
div.sphinxsidebar h4 {
font-family: Georgia, serif;
color: #444;
font-size: 24px;
font-weight: normal;
margin: 0 0 5px 0;
padding: 0;
}
div.sphinxsidebar h4 {
font-size: 20px;
}
div.sphinxsidebar h3 a {
color: #444;
}
div.sphinxsidebar p.logo a,
div.sphinxsidebar h3 a,
div.sphinxsidebar p.logo a:hover,
div.sphinxsidebar h3 a:hover {
border: none;
}
div.sphinxsidebar p {
color: #555;
margin: 10px 0;
}
div.sphinxsidebar ul {
margin: 10px 0;
padding: 0;
color: #000;
}
div.sphinxsidebar ul li.toctree-l1 > a {
font-size: 120%;
}
div.sphinxsidebar ul li.toctree-l2 > a {
font-size: 110%;
}
div.sphinxsidebar input {
border: 1px solid #CCC;
font-family: Georgia, serif;
font-size: 1em;
}
div.sphinxsidebar hr {
border: none;
height: 1px;
color: #AAA;
background: #AAA;
text-align: left;
margin-left: 0;
width: 50%;
}
div.sphinxsidebar .badge {
border-bottom: none;
}
div.sphinxsidebar .badge:hover {
border-bottom: none;
}
/* To address an issue with donation coming after search */
div.sphinxsidebar h3.donation {
margin-top: 10px;
}
/* -- body styles ----------------------------------------------------------- */
a {
color: #004B6B;
text-decoration: underline;
}
a:hover {
color: #6D4100;
text-decoration: underline;
}
div.body h1,
div.body h2,
div.body h3,
div.body h4,
div.body h5,
div.body h6 {
font-family: Georgia, serif;
font-weight: normal;
margin: 30px 0px 10px 0px;
padding: 0;
}
div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; }
div.body h2 { font-size: 180%; }
div.body h3 { font-size: 150%; }
div.body h4 { font-size: 130%; }
div.body h5 { font-size: 100%; }
div.body h6 { font-size: 100%; }
a.headerlink {
color: #DDD;
padding: 0 4px;
text-decoration: none;
}
a.headerlink:hover {
color: #444;
background: #EAEAEA;
}
div.body p, div.body dd, div.body li {
line-height: 1.4em;
}
div.admonition {
margin: 20px 0px;
padding: 10px 30px;
background-color: #EEE;
border: 1px solid #CCC;
}
div.admonition tt.xref, div.admonition code.xref, div.admonition a tt {
background-color: #FBFBFB;
border-bottom: 1px solid #fafafa;
}
div.admonition p.admonition-title {
font-family: Georgia, serif;
font-weight: normal;
font-size: 24px;
margin: 0 0 10px 0;
padding: 0;
line-height: 1;
}
div.admonition p.last {
margin-bottom: 0;
}
div.highlight {
background-color: #fff;
}
dt:target, .highlight {
background: #FAF3E8;
}
div.warning {
background-color: #FCC;
border: 1px solid #FAA;
}
div.danger {
background-color: #FCC;
border: 1px solid #FAA;
-moz-box-shadow: 2px 2px 4px #D52C2C;
-webkit-box-shadow: 2px 2px 4px #D52C2C;
box-shadow: 2px 2px 4px #D52C2C;
}
div.error {
background-color: #FCC;
border: 1px solid #FAA;
-moz-box-shadow: 2px 2px 4px #D52C2C;
-webkit-box-shadow: 2px 2px 4px #D52C2C;
box-shadow: 2px 2px 4px #D52C2C;
}
div.caution {
background-color: #FCC;
border: 1px solid #FAA;
}
div.attention {
background-color: #FCC;
border: 1px solid #FAA;
}
div.important {
background-color: #EEE;
border: 1px solid #CCC;
}
div.note {
background-color: #EEE;
border: 1px solid #CCC;
}
div.tip {
background-color: #EEE;
border: 1px solid #CCC;
}
div.hint {
background-color: #EEE;
border: 1px solid #CCC;
}
div.seealso {
background-color: #EEE;
border: 1px solid #CCC;
}
div.topic {
background-color: #EEE;
}
p.admonition-title {
display: inline;
}
p.admonition-title:after {
content: ":";
}
pre, tt, code {
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
font-size: 0.9em;
}
.hll {
background-color: #FFC;
margin: 0 -12px;
padding: 0 12px;
display: block;
}
img.screenshot {
}
tt.descname, tt.descclassname, code.descname, code.descclassname {
font-size: 0.95em;
}
tt.descname, code.descname {
padding-right: 0.08em;
}
img.screenshot {
-moz-box-shadow: 2px 2px 4px #EEE;
-webkit-box-shadow: 2px 2px 4px #EEE;
box-shadow: 2px 2px 4px #EEE;
}
table.docutils {
border: 1px solid #888;
-moz-box-shadow: 2px 2px 4px #EEE;
-webkit-box-shadow: 2px 2px 4px #EEE;
box-shadow: 2px 2px 4px #EEE;
}
table.docutils td, table.docutils th {
border: 1px solid #888;
padding: 0.25em 0.7em;
}
table.field-list, table.footnote {
border: none;
-moz-box-shadow: none;
-webkit-box-shadow: none;
box-shadow: none;
}
table.footnote {
margin: 15px 0;
width: 100%;
border: 1px solid #EEE;
background: #FDFDFD;
font-size: 0.9em;
}
table.footnote + table.footnote {
margin-top: -15px;
border-top: none;
}
table.field-list th {
padding: 0 0.8em 0 0;
}
table.field-list td {
padding: 0;
}
table.field-list p {
margin-bottom: 0.8em;
}
/* Cloned from
* https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68
*/
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}
table.footnote td.label {
width: .1px;
padding: 0.3em 0 0.3em 0.5em;
}
table.footnote td {
padding: 0.3em 0.5em;
}
dl {
margin: 0;
padding: 0;
}
dl dd {
margin-left: 30px;
}
blockquote {
margin: 0 0 0 30px;
padding: 0;
}
ul, ol {
/* Matches the 30px from the narrow-screen "li > ul" selector below */
margin: 10px 0 10px 30px;
padding: 0;
}
pre {
background: #EEE;
padding: 7px 30px;
margin: 15px 0px;
line-height: 1.3em;
}
div.viewcode-block:target {
background: #ffd;
}
dl pre, blockquote pre, li pre {
margin-left: 0;
padding-left: 30px;
}
tt, code {
background-color: #ecf0f3;
color: #222;
/* padding: 1px 2px; */
}
tt.xref, code.xref, a tt {
background-color: #FBFBFB;
border-bottom: 1px solid #fff;
}
a.reference {
text-decoration: none;
border-bottom: 1px dotted #004B6B;
}
/* Don't put an underline on images */
a.image-reference, a.image-reference:hover {
border-bottom: none;
}
a.reference:hover {
border-bottom: 1px solid #6D4100;
}
a.footnote-reference {
text-decoration: none;
font-size: 0.7em;
vertical-align: top;
border-bottom: 1px dotted #004B6B;
}
a.footnote-reference:hover {
border-bottom: 1px solid #6D4100;
}
a:hover tt, a:hover code {
background: #EEE;
}
@media screen and (max-width: 870px) {
div.sphinxsidebar {
display: none;
}
div.document {
width: 100%;
}
div.documentwrapper {
margin-left: 0;
margin-top: 0;
margin-right: 0;
margin-bottom: 0;
}
div.bodywrapper {
margin-top: 0;
margin-right: 0;
margin-bottom: 0;
margin-left: 0;
}
ul {
margin-left: 0;
}
li > ul {
/* Matches the 30px from the "ul, ol" selector above */
margin-left: 30px;
}
.document {
width: auto;
}
.footer {
width: auto;
}
.bodywrapper {
margin: 0;
}
.footer {
width: auto;
}
.github {
display: none;
}
}
@media screen and (max-width: 875px) {
body {
margin: 0;
padding: 20px 30px;
}
div.documentwrapper {
float: none;
background: #fff;
}
div.sphinxsidebar {
display: block;
float: none;
width: 102.5%;
margin: 50px -30px -20px -30px;
padding: 10px 20px;
background: #333;
color: #FFF;
}
div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p,
div.sphinxsidebar h3 a {
color: #fff;
}
div.sphinxsidebar a {
color: #AAA;
}
div.sphinxsidebar p.logo {
display: none;
}
div.document {
width: 100%;
margin: 0;
}
div.footer {
display: none;
}
div.bodywrapper {
margin: 0;
}
div.body {
min-height: 0;
padding: 0;
}
.rtd_doc_footer {
display: none;
}
.document {
width: auto;
}
.footer {
width: auto;
}
.footer {
width: auto;
}
.github {
display: none;
}
}
/* misc. */
.revsys-inline {
display: none!important;
}
/* Make nested-list/multi-paragraph items look better in Releases changelog
* pages. Without this, docutils' magical list fuckery causes inconsistent
* formatting between different release sub-lists.
*/
div#changelog > div.section > ul > li > p:only-child {
margin-bottom: 0;
}
/* Hide fugly table cell borders in ..bibliography:: directive output */
table.docutils.citation, table.docutils.citation td, table.docutils.citation th {
border: none;
/* Below needed in some edge cases; if not applied, bottom shadows appear */
-moz-box-shadow: none;
-webkit-box-shadow: none;
box-shadow: none;
}
/* relbar */
.related {
line-height: 30px;
width: 100%;
font-size: 0.9rem;
}
.related.top {
border-bottom: 1px solid #EEE;
margin-bottom: 20px;
}
.related.bottom {
border-top: 1px solid #EEE;
}
.related ul {
padding: 0;
margin: 0;
list-style: none;
}
.related li {
display: inline;
}
nav#rellinks {
float: right;
}
nav#rellinks li+li:before {
content: "|";
}
nav#breadcrumbs li+li:before {
content: "\00BB";
}
/* Hide certain items when printing */
@media print {
div.related {
display: none;
}
}

905
docs/html/_static/basic.css Normal file
View File

@ -0,0 +1,905 @@
/*
* basic.css
* ~~~~~~~~~
*
* Sphinx stylesheet -- basic theme.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
}
div.section::after {
display: block;
content: '';
clear: left;
}
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
word-wrap: break-word;
overflow-wrap : break-word;
}
div.sphinxsidebar ul {
list-style: none;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
div.sphinxsidebar #searchbox form.search {
overflow: hidden;
}
div.sphinxsidebar #searchbox input[type="text"] {
float: left;
width: 80%;
padding: 0.25em;
box-sizing: border-box;
}
div.sphinxsidebar #searchbox input[type="submit"] {
float: left;
width: 20%;
border-left: none;
padding: 0.25em;
box-sizing: border-box;
}
img {
border: 0;
max-width: 100%;
}
/* -- search page ----------------------------------------------------------- */
ul.search {
margin: 10px 0 0 20px;
padding: 0;
}
ul.search li {
padding: 5px 0 5px 20px;
background-image: url(file.png);
background-repeat: no-repeat;
background-position: 0 7px;
}
ul.search li a {
font-weight: bold;
}
ul.search li p.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
margin-left: auto;
margin-right: auto;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
}
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable ul {
margin-top: 0;
margin-bottom: 0;
list-style-type: none;
}
table.indextable > tbody > tr > td > ul {
padding-left: 0em;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
/* -- domain module index --------------------------------------------------- */
table.modindextable td {
padding: 2px;
border-collapse: collapse;
}
/* -- general body styles --------------------------------------------------- */
div.body {
min-width: 450px;
max-width: 800px;
}
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
-webkit-hyphens: auto;
hyphens: auto;
}
a.headerlink {
visibility: hidden;
}
a.brackets:before,
span.brackets > a:before{
content: "[";
}
a.brackets:after,
span.brackets > a:after {
content: "]";
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink,
caption:hover > a.headerlink,
p.caption:hover > a.headerlink,
div.code-block-caption:hover > a.headerlink {
visibility: visible;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
.first {
margin-top: 0 !important;
}
p.rubric {
margin-top: 30px;
font-weight: bold;
}
img.align-left, figure.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em;
}
img.align-right, figure.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em;
}
img.align-center, figure.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
img.align-default, figure.align-default, .figure.align-default {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left;
}
.align-center {
text-align: center;
}
.align-default {
text-align: center;
}
.align-right {
text-align: right;
}
/* -- sidebars -------------------------------------------------------------- */
div.sidebar,
aside.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px;
background-color: #ffe;
width: 40%;
float: right;
clear: right;
overflow-x: auto;
}
p.sidebar-title {
font-weight: bold;
}
div.admonition, div.topic, blockquote {
clear: left;
}
/* -- topics ---------------------------------------------------------------- */
div.topic {
border: 1px solid #ccc;
padding: 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
/* -- content of sidebars/topics/admonitions -------------------------------- */
div.sidebar > :last-child,
aside.sidebar > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}
div.sidebar::after,
aside.sidebar::after,
div.topic::after,
div.admonition::after,
blockquote::after {
display: block;
content: '';
clear: both;
}
/* -- tables ---------------------------------------------------------------- */
table.docutils {
margin-top: 10px;
margin-bottom: 10px;
border: 0;
border-collapse: collapse;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
table.align-default {
margin-left: auto;
margin-right: auto;
}
table caption span.caption-number {
font-style: italic;
}
table caption span.caption-text {
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
table.footnote td, table.footnote th {
border: 0 !important;
}
th {
text-align: left;
padding-right: 5px;
}
table.citation {
border-left: solid 1px gray;
margin-left: 1px;
}
table.citation td {
border-bottom: none;
}
th > :first-child,
td > :first-child {
margin-top: 0px;
}
th > :last-child,
td > :last-child {
margin-bottom: 0px;
}
/* -- figures --------------------------------------------------------------- */
div.figure, figure {
margin: 0.5em;
padding: 0.5em;
}
div.figure p.caption, figcaption {
padding: 0.3em;
}
div.figure p.caption span.caption-number,
figcaption span.caption-number {
font-style: italic;
}
div.figure p.caption span.caption-text,
figcaption span.caption-text {
}
/* -- field list styles ----------------------------------------------------- */
table.field-list td, table.field-list th {
border: 0 !important;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}
/* -- hlist styles ---------------------------------------------------------- */
table.hlist {
margin: 1em 0;
}
table.hlist td {
vertical-align: top;
}
/* -- object description styles --------------------------------------------- */
.sig {
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
}
.sig-name, code.descname {
background-color: transparent;
font-weight: bold;
}
.sig-name {
font-size: 1.1em;
}
code.descname {
font-size: 1.2em;
}
.sig-prename, code.descclassname {
background-color: transparent;
}
.optional {
font-size: 1.3em;
}
.sig-paren {
font-size: larger;
}
.sig-param.n {
font-style: italic;
}
/* C++ specific styling */
.sig-inline.c-texpr,
.sig-inline.cpp-texpr {
font-family: unset;
}
.sig.c .k, .sig.c .kt,
.sig.cpp .k, .sig.cpp .kt {
color: #0033B3;
}
.sig.c .m,
.sig.cpp .m {
color: #1750EB;
}
.sig.c .s, .sig.c .sc,
.sig.cpp .s, .sig.cpp .sc {
color: #067D17;
}
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
list-style: decimal;
}
ol.loweralpha {
list-style: lower-alpha;
}
ol.upperalpha {
list-style: upper-alpha;
}
ol.lowerroman {
list-style: lower-roman;
}
ol.upperroman {
list-style: upper-roman;
}
:not(li) > ol > li:first-child > :first-child,
:not(li) > ul > li:first-child > :first-child {
margin-top: 0px;
}
:not(li) > ol > li:last-child > :last-child,
:not(li) > ul > li:last-child > :last-child {
margin-bottom: 0px;
}
ol.simple ol p,
ol.simple ul p,
ul.simple ol p,
ul.simple ul p {
margin-top: 0;
}
ol.simple > li:not(:first-child) > p,
ul.simple > li:not(:first-child) > p {
margin-top: 0;
}
ol.simple p,
ul.simple p {
margin-bottom: 0;
}
dl.footnote > dt,
dl.citation > dt {
float: left;
margin-right: 0.5em;
}
dl.footnote > dd,
dl.citation > dd {
margin-bottom: 0em;
}
dl.footnote > dd:after,
dl.citation > dd:after {
content: "";
clear: both;
}
dl.field-list {
display: grid;
grid-template-columns: fit-content(30%) auto;
}
dl.field-list > dt {
font-weight: bold;
word-break: break-word;
padding-left: 0.5em;
padding-right: 5px;
}
dl.field-list > dt:after {
content: ":";
}
dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
margin-left: 0em;
margin-bottom: 0em;
}
dl {
margin-bottom: 15px;
}
dd > :first-child {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
}
dt:target, span.highlighted {
background-color: #fbe54e;
}
rect.highlighted {
fill: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.versionmodified {
font-style: italic;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
.footnote:target {
background-color: #ffa;
}
.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em;
}
.line-block .line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em;
}
.guilabel, .menuselection {
font-family: sans-serif;
}
.accelerator {
text-decoration: underline;
}
.classifier {
font-style: oblique;
}
.classifier:before {
font-style: normal;
margin: 0 0.5em;
content: ":";
display: inline-block;
}
abbr, acronym {
border-bottom: dotted 1px;
cursor: help;
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
pre, div[class*="highlight-"] {
clear: both;
}
span.pre {
-moz-hyphens: none;
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
}
div[class*="highlight-"] {
margin: 1em 0;
}
td.linenos pre {
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
display: block;
}
table.highlighttable tbody {
display: block;
}
table.highlighttable tr {
display: flex;
}
table.highlighttable td {
margin: 0;
padding: 0;
}
table.highlighttable td.linenos {
padding-right: 0.5em;
}
table.highlighttable td.code {
flex: 1;
overflow: hidden;
}
.highlight .hll {
display: block;
}
div.highlight pre,
table.highlighttable pre {
margin: 0;
}
div.code-block-caption + div {
margin-top: 0;
}
div.code-block-caption {
margin-top: 1em;
padding: 2px 5px;
font-size: small;
}
div.code-block-caption code {
background-color: transparent;
}
table.highlighttable td.linenos,
span.linenos,
div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
-webkit-user-select: text; /* Safari fallback only */
-webkit-user-select: none; /* Chrome/Safari */
-moz-user-select: none; /* Firefox */
-ms-user-select: none; /* IE10+ */
}
div.code-block-caption span.caption-number {
padding: 0.1em 0.3em;
font-style: italic;
}
div.code-block-caption span.caption-text {
}
div.literal-block-wrapper {
margin: 1em 0;
}
code.xref, a code {
background-color: transparent;
font-weight: bold;
}
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
background-color: transparent;
}
.viewcode-link {
float: right;
}
.viewcode-back {
float: right;
font-family: sans-serif;
}
div.viewcode-block:target {
margin: -1px -10px;
padding: 0 10px;
}
/* -- math display ---------------------------------------------------------- */
img.math {
vertical-align: middle;
}
div.body div.math p {
text-align: center;
}
span.eqno {
float: right;
}
span.eqno a.headerlink {
position: absolute;
z-index: 1;
}
div.math:hover a.headerlink {
visibility: visible;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0 !important;
width: 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
#top-link {
display: none;
}
}

1
docs/html/_static/custom.css Normal file
View File

@ -0,0 +1 @@
/* This file intentionally left blank. */

323
docs/html/_static/doctools.js Normal file
View File

@ -0,0 +1,323 @@
/*
* doctools.js
* ~~~~~~~~~~~
*
* Sphinx JavaScript utilities for all documentation.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
/**
* select a different prefix for underscore
*/
$u = _.noConflict();
/**
* make the code below compatible with browsers without
* an installed firebug like debugger
if (!window.console || !console.firebug) {
var names = ["log", "debug", "info", "warn", "error", "assert", "dir",
"dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace",
"profile", "profileEnd"];
window.console = {};
for (var i = 0; i < names.length; ++i)
window.console[names[i]] = function() {};
}
*/
/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};
/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;
/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};
/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};
/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];
return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}
/**
* Small JavaScript module for the documentation.
*/
var Documentation = {
init : function() {
this.fixFirefoxAnchorBug();
this.highlightSearchWords();
this.initIndexTable();
if (DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) {
this.initOnKeyListeners();
}
},
/**
* i18n support
*/
TRANSLATIONS : {},
PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; },
LOCALE : 'unknown',
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext : function(string) {
var translated = Documentation.TRANSLATIONS[string];
if (typeof translated === 'undefined')
return string;
return (typeof translated === 'string') ? translated : translated[0];
},
ngettext : function(singular, plural, n) {
var translated = Documentation.TRANSLATIONS[singular];
if (typeof translated === 'undefined')
return (n == 1) ? singular : plural;
return translated[Documentation.PLURALEXPR(n)];
},
addTranslations : function(catalog) {
for (var key in catalog.messages)
this.TRANSLATIONS[key] = catalog.messages[key];
this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')');
this.LOCALE = catalog.locale;
},
/**
* add context elements like header anchor links
*/
addContextElements : function() {
$('div[id] > :header:first').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this headline')).
appendTo(this);
});
$('dt[id]').each(function() {
$('<a class="headerlink">\u00B6</a>').
attr('href', '#' + this.id).
attr('title', _('Permalink to this definition')).
appendTo(this);
});
},
/**
* workaround a firefox stupidity
* see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075
*/
fixFirefoxAnchorBug : function() {
if (document.location.hash && $.browser.mozilla)
window.setTimeout(function() {
document.location.href += '';
}, 10);
},
/**
* highlight the search words provided in the url in the text
*/
highlightSearchWords : function() {
var params = $.getQueryParameters();
var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : [];
if (terms.length) {
var body = $('div.body');
if (!body.length) {
body = $('body');
}
window.setTimeout(function() {
$.each(terms, function() {
body.highlightText(this.toLowerCase(), 'highlighted');
});
}, 10);
$('<p class="highlight-link"><a href="javascript:Documentation.' +
'hideSearchWords()">' + _('Hide Search Matches') + '</a></p>')
.appendTo($('#searchbox'));
}
},
/**
* init the domain index toggle buttons
*/
initIndexTable : function() {
var togglers = $('img.toggler').click(function() {
var src = $(this).attr('src');
var idnum = $(this).attr('id').substr(7);
$('tr.cg-' + idnum).toggle();
if (src.substr(-9) === 'minus.png')
$(this).attr('src', src.substr(0, src.length-9) + 'plus.png');
else
$(this).attr('src', src.substr(0, src.length-8) + 'minus.png');
}).css('display', '');
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) {
togglers.click();
}
},
/**
* helper function to hide the search marks again
*/
hideSearchWords : function() {
$('#searchbox .highlight-link').fadeOut(300);
$('span.highlighted').removeClass('highlighted');
},
/**
* make the url absolute
*/
makeURL : function(relativeURL) {
return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL;
},
/**
* get the current relative url
*/
getCurrentURL : function() {
var path = document.location.pathname;
var parts = path.split(/\//);
$.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() {
if (this === '..')
parts.pop();
});
var url = parts.join('/');
return path.substring(url.lastIndexOf('/') + 1, path.length - 1);
},
initOnKeyListeners: function() {
$(document).keydown(function(event) {
var activeElementType = document.activeElement.tagName;
// don't navigate when in search box, textarea, dropdown or button
if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT'
&& activeElementType !== 'BUTTON' && !event.altKey && !event.ctrlKey && !event.metaKey
&& !event.shiftKey) {
switch (event.keyCode) {
case 37: // left
var prevHref = $('link[rel="prev"]').prop('href');
if (prevHref) {
window.location.href = prevHref;
return false;
}
break;
case 39: // right
var nextHref = $('link[rel="next"]').prop('href');
if (nextHref) {
window.location.href = nextHref;
return false;
}
break;
}
}
});
}
};
// quick alias for translations
_ = Documentation.gettext;
$(document).ready(function() {
Documentation.init();
});

12
docs/html/_static/documentation_options.js Normal file
View File

@ -0,0 +1,12 @@
var DOCUMENTATION_OPTIONS = {
URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
VERSION: 'v0.0.3',
LANGUAGE: 'None',
COLLAPSE_INDEX: false,
BUILDER: 'html',
FILE_SUFFIX: '.html',
LINK_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false
};

BIN
docs/html/_static/file.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 286 B

10872
docs/html/_static/jquery-3.5.1.js vendored Normal file
View File

File diff suppressed because it is too large Load Diff

2
docs/html/_static/jquery.js vendored Normal file
View File

File diff suppressed because one or more lines are too long

297
docs/html/_static/language_data.js Normal file
View File

@ -0,0 +1,297 @@
/*
* language_data.js
* ~~~~~~~~~~~~~~~~
*
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
var stopwords = ["a","and","are","as","at","be","but","by","for","if","in","into","is","it","near","no","not","of","on","or","such","that","the","their","then","there","these","they","this","to","was","will","with"];
/* Non-minified version is copied as a separate JS file, is available */
/**
* Porter Stemmer
*/
var Stemmer = function() {
var step2list = {
ational: 'ate',
tional: 'tion',
enci: 'ence',
anci: 'ance',
izer: 'ize',
bli: 'ble',
alli: 'al',
entli: 'ent',
eli: 'e',
ousli: 'ous',
ization: 'ize',
ation: 'ate',
ator: 'ate',
alism: 'al',
iveness: 'ive',
fulness: 'ful',
ousness: 'ous',
aliti: 'al',
iviti: 'ive',
biliti: 'ble',
logi: 'log'
};
var step3list = {
icate: 'ic',
ative: '',
alize: 'al',
iciti: 'ic',
ical: 'ic',
ful: '',
ness: ''
};
var c = "[^aeiou]"; // consonant
var v = "[aeiouy]"; // vowel
var C = c + "[^aeiouy]*"; // consonant sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
var stem;
var suffix;
var firstch;
var origword = w;
if (w.length < 3)
return w;
var re;
var re2;
var re3;
var re4;
firstch = w.substr(0,1);
if (firstch == "y")
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
re = /^(.+?)(ss|i)es$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
w = w.replace(re,"$1$2");
else if (re2.test(w))
w = w.replace(re2,"$1$2");
// Step 1b
re = /^(.+?)eed$/;
re2 = /^(.+?)(ed|ing)$/;
if (re.test(w)) {
var fp = re.exec(w);
re = new RegExp(mgr0);
if (re.test(fp[1])) {
re = /.$/;
w = w.replace(re,"");
}
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1];
re2 = new RegExp(s_v);
if (re2.test(stem)) {
w = stem;
re2 = /(at|bl|iz)$/;
re3 = new RegExp("([^aeiouylsz])\\1$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re2.test(w))
w = w + "e";
else if (re3.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
else if (re4.test(w))
w = w + "e";
}
}
// Step 1c
re = /^(.+?)y$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(s_v);
if (re.test(stem))
w = stem + "i";
}
// Step 2
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step2list[suffix];
}
// Step 3
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step3list[suffix];
}
// Step 4
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re2 = /^(.+?)(s|t)(ion)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
if (re.test(stem))
w = stem;
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1] + fp[2];
re2 = new RegExp(mgr1);
if (re2.test(stem))
w = stem;
}
// Step 5
re = /^(.+?)e$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
re2 = new RegExp(meq1);
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
w = stem;
}
re = /ll$/;
re2 = new RegExp(mgr1);
if (re.test(w) && re2.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
// and turn initial Y back to y
if (firstch == "y")
w = firstch.toLowerCase() + w.substr(1);
return w;
}
}
var splitChars = (function() {
var result = {};
var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
var i, j, start, end;
for (i = 0; i < singles.length; i++) {
result[singles[i]] = true;
}
var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
[722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
[1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
[1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
[1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
[2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
[2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
[2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
[2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
[2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
[2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
[2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
[3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
[3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
[3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
[3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
[3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
[3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
[4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
[4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
[4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
[4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
[5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
[6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
[6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
[6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
[6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
[7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
[7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
[8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
[8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
[8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
[10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
[11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
[12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
[12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
[12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
[19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
[42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
[42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
[43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
[43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
[43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
[43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
[44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
[57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
[64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
[65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
[65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
for (i = 0; i < ranges.length; i++) {
start = ranges[i][0];
end = ranges[i][1];
for (j = start; j <= end; j++) {
result[j] = true;
}
}
return result;
})();
function splitQuery(query) {
var result = [];
var start = -1;
for (var i = 0; i < query.length; i++) {
if (splitChars[query.charCodeAt(i)]) {
if (start !== -1) {
result.push(query.slice(start, i));
start = -1;
}
} else if (start === -1) {
start = i;
}
}
if (start !== -1) {
result.push(query.slice(start));
}
return result;
}

BIN
docs/html/_static/minus.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 90 B

BIN
docs/html/_static/plus.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 90 B

82
docs/html/_static/pygments.css Normal file
View File

@ -0,0 +1,82 @@
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; }
.highlight .c { color: #8f5902; font-style: italic } /* Comment */
.highlight .err { color: #a40000; border: 1px solid #ef2929 } /* Error */
.highlight .g { color: #000000 } /* Generic */
.highlight .k { color: #004461; font-weight: bold } /* Keyword */
.highlight .l { color: #000000 } /* Literal */
.highlight .n { color: #000000 } /* Name */
.highlight .o { color: #582800 } /* Operator */
.highlight .x { color: #000000 } /* Other */
.highlight .p { color: #000000; font-weight: bold } /* Punctuation */
.highlight .ch { color: #8f5902; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #8f5902; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #8f5902 } /* Comment.Preproc */
.highlight .cpf { color: #8f5902; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #8f5902; font-style: italic } /* Comment.Single */
.highlight .cs { color: #8f5902; font-style: italic } /* Comment.Special */
.highlight .gd { color: #a40000 } /* Generic.Deleted */
.highlight .ge { color: #000000; font-style: italic } /* Generic.Emph */
.highlight .gr { color: #ef2929 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #745334 } /* Generic.Prompt */
.highlight .gs { color: #000000; font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #a40000; font-weight: bold } /* Generic.Traceback */
.highlight .kc { color: #004461; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #004461; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #004461; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #004461; font-weight: bold } /* Keyword.Pseudo */
.highlight .kr { color: #004461; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #004461; font-weight: bold } /* Keyword.Type */
.highlight .ld { color: #000000 } /* Literal.Date */
.highlight .m { color: #990000 } /* Literal.Number */
.highlight .s { color: #4e9a06 } /* Literal.String */
.highlight .na { color: #c4a000 } /* Name.Attribute */
.highlight .nb { color: #004461 } /* Name.Builtin */
.highlight .nc { color: #000000 } /* Name.Class */
.highlight .no { color: #000000 } /* Name.Constant */
.highlight .nd { color: #888888 } /* Name.Decorator */
.highlight .ni { color: #ce5c00 } /* Name.Entity */
.highlight .ne { color: #cc0000; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #000000 } /* Name.Function */
.highlight .nl { color: #f57900 } /* Name.Label */
.highlight .nn { color: #000000 } /* Name.Namespace */
.highlight .nx { color: #000000 } /* Name.Other */
.highlight .py { color: #000000 } /* Name.Property */
.highlight .nt { color: #004461; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #000000 } /* Name.Variable */
.highlight .ow { color: #004461; font-weight: bold } /* Operator.Word */
.highlight .w { color: #f8f8f8; text-decoration: underline } /* Text.Whitespace */
.highlight .mb { color: #990000 } /* Literal.Number.Bin */
.highlight .mf { color: #990000 } /* Literal.Number.Float */
.highlight .mh { color: #990000 } /* Literal.Number.Hex */
.highlight .mi { color: #990000 } /* Literal.Number.Integer */
.highlight .mo { color: #990000 } /* Literal.Number.Oct */
.highlight .sa { color: #4e9a06 } /* Literal.String.Affix */
.highlight .sb { color: #4e9a06 } /* Literal.String.Backtick */
.highlight .sc { color: #4e9a06 } /* Literal.String.Char */
.highlight .dl { color: #4e9a06 } /* Literal.String.Delimiter */
.highlight .sd { color: #8f5902; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4e9a06 } /* Literal.String.Double */
.highlight .se { color: #4e9a06 } /* Literal.String.Escape */
.highlight .sh { color: #4e9a06 } /* Literal.String.Heredoc */
.highlight .si { color: #4e9a06 } /* Literal.String.Interpol */
.highlight .sx { color: #4e9a06 } /* Literal.String.Other */
.highlight .sr { color: #4e9a06 } /* Literal.String.Regex */
.highlight .s1 { color: #4e9a06 } /* Literal.String.Single */
.highlight .ss { color: #4e9a06 } /* Literal.String.Symbol */
.highlight .bp { color: #3465a4 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #000000 } /* Name.Function.Magic */
.highlight .vc { color: #000000 } /* Name.Variable.Class */
.highlight .vg { color: #000000 } /* Name.Variable.Global */
.highlight .vi { color: #000000 } /* Name.Variable.Instance */
.highlight .vm { color: #000000 } /* Name.Variable.Magic */
.highlight .il { color: #990000 } /* Literal.Number.Integer.Long */

529
docs/html/_static/searchtools.js Normal file
View File

@ -0,0 +1,529 @@
/*
* searchtools.js
* ~~~~~~~~~~~~~~~~
*
* Sphinx JavaScript utilities for the full-text search.
*
* :copyright: Copyright 2007-2021 by the Sphinx team, see AUTHORS.
* :license: BSD, see LICENSE for details.
*
*/
if (!Scorer) {
/**
* Simple result scoring code.
*/
var Scorer = {
// Implement the following function to further tweak the score for each result
// The function takes a result array [filename, title, anchor, descr, score]
// and returns the new score.
/*
score: function(result) {
return result[4];
},
*/
// query matches the full name of an object
objNameMatch: 11,
// or matches in the last dotted part of the object name
objPartialMatch: 6,
// Additive scores depending on the priority of the object
objPrio: {0: 15, // used to be importantResults
1: 5, // used to be objectResults
2: -5}, // used to be unimportantResults
// Used when the priority is not in the mapping.
objPrioDefault: 0,
// query found in title
title: 15,
partialTitle: 7,
// query found in terms
term: 5,
partialTerm: 2
};
}
if (!splitQuery) {
function splitQuery(query) {
return query.split(/\s+/);
}
}
/**
* Search Module
*/
var Search = {
_index : null,
_queued_query : null,
_pulse_status : -1,
htmlToText : function(htmlString) {
var virtualDocument = document.implementation.createHTMLDocument('virtual');
var htmlElement = $(htmlString, virtualDocument);
htmlElement.find('.headerlink').remove();
docContent = htmlElement.find('[role=main]')[0];
if(docContent === undefined) {
console.warn("Content block not found. Sphinx search tries to obtain it " +
"via '[role=main]'. Could you check your theme or template.");
return "";
}
return docContent.textContent || docContent.innerText;
},
init : function() {
var params = $.getQueryParameters();
if (params.q) {
var query = params.q[0];
$('input[name="q"]')[0].value = query;
this.performSearch(query);
}
},
loadIndex : function(url) {
$.ajax({type: "GET", url: url, data: null,
dataType: "script", cache: true,
complete: function(jqxhr, textstatus) {
if (textstatus != "success") {
document.getElementById("searchindexloader").src = url;
}
}});
},
setIndex : function(index) {
var q;
this._index = index;
if ((q = this._queued_query) !== null) {
this._queued_query = null;
Search.query(q);
}
},
hasIndex : function() {
return this._index !== null;
},
deferQuery : function(query) {
this._queued_query = query;
},
stopPulse : function() {
this._pulse_status = 0;
},
startPulse : function() {
if (this._pulse_status >= 0)
return;
function pulse() {
var i;
Search._pulse_status = (Search._pulse_status + 1) % 4;
var dotString = '';
for (i = 0; i < Search._pulse_status; i++)
dotString += '.';
Search.dots.text(dotString);
if (Search._pulse_status > -1)
window.setTimeout(pulse, 500);
}
pulse();
},
/**
* perform a search for something (or wait until index is loaded)
*/
performSearch : function(query) {
// create the required interface elements
this.out = $('#search-results');
this.title = $('<h2>' + _('Searching') + '</h2>').appendTo(this.out);
this.dots = $('<span></span>').appendTo(this.title);
this.status = $('<p class="search-summary">&nbsp;</p>').appendTo(this.out);
this.output = $('<ul class="search"/>').appendTo(this.out);
$('#search-progress').text(_('Preparing search...'));
this.startPulse();
// index already loaded, the browser was quick!
if (this.hasIndex())
this.query(query);
else
this.deferQuery(query);
},
/**
* execute search (requires search index to be loaded)
*/
query : function(query) {
var i;
// stem the searchterms and add them to the correct list
var stemmer = new Stemmer();
var searchterms = [];
var excluded = [];
var hlterms = [];
var tmp = splitQuery(query);
var objectterms = [];
for (i = 0; i < tmp.length; i++) {
if (tmp[i] !== "") {
objectterms.push(tmp[i].toLowerCase());
}
if ($u.indexOf(stopwords, tmp[i].toLowerCase()) != -1 || tmp[i] === "") {
// skip this "word"
continue;
}
// stem the word
var word = stemmer.stemWord(tmp[i].toLowerCase());
// prevent stemmer from cutting word smaller than two chars
if(word.length < 3 && tmp[i].length >= 3) {
word = tmp[i];
}
var toAppend;
// select the correct list
if (word[0] == '-') {
toAppend = excluded;
word = word.substr(1);
}
else {
toAppend = searchterms;
hlterms.push(tmp[i].toLowerCase());
}
// only add if not already in the list
if (!$u.contains(toAppend, word))
toAppend.push(word);
}
var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" "));
// console.debug('SEARCH: searching for:');
// console.info('required: ', searchterms);
// console.info('excluded: ', excluded);
// prepare search
var terms = this._index.terms;
var titleterms = this._index.titleterms;
// array of [filename, title, anchor, descr, score]
var results = [];
$('#search-progress').empty();
// lookup as object
for (i = 0; i < objectterms.length; i++) {
var others = [].concat(objectterms.slice(0, i),
objectterms.slice(i+1, objectterms.length));
results = results.concat(this.performObjectSearch(objectterms[i], others));
}
// lookup as search terms in fulltext
results = results.concat(this.performTermsSearch(searchterms, excluded, terms, titleterms));
// let the scorer override scores with a custom scoring function
if (Scorer.score) {
for (i = 0; i < results.length; i++)
results[i][4] = Scorer.score(results[i]);
}
// now sort the results by score (in opposite order of appearance, since the
// display function below uses pop() to retrieve items) and then
// alphabetically
results.sort(function(a, b) {
var left = a[4];
var right = b[4];
if (left > right) {
return 1;
} else if (left < right) {
return -1;
} else {
// same score: sort alphabetically
left = a[1].toLowerCase();
right = b[1].toLowerCase();
return (left > right) ? -1 : ((left < right) ? 1 : 0);
}
});
// for debugging
//Search.lastresults = results.slice(); // a copy
//console.info('search results:', Search.lastresults);
// print the results
var resultCount = results.length;
function displayNextItem() {
// results left, load the summary and display it
if (results.length) {
var item = results.pop();
var listItem = $('<li></li>');
var requestUrl = "";
var linkUrl = "";
if (DOCUMENTATION_OPTIONS.BUILDER === 'dirhtml') {
// dirhtml builder
var dirname = item[0] + '/';
if (dirname.match(/\/index\/$/)) {
dirname = dirname.substring(0, dirname.length-6);
} else if (dirname == 'index/') {
dirname = '';
}
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + dirname;
linkUrl = requestUrl;
} else {
// normal html builders
requestUrl = DOCUMENTATION_OPTIONS.URL_ROOT + item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX;
linkUrl = item[0] + DOCUMENTATION_OPTIONS.LINK_SUFFIX;
}
listItem.append($('<a/>').attr('href',
linkUrl +
highlightstring + item[2]).html(item[1]));
if (item[3]) {
listItem.append($('<span> (' + item[3] + ')</span>'));
Search.output.append(listItem);
setTimeout(function() {
displayNextItem();
}, 5);
} else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) {
$.ajax({url: requestUrl,
dataType: "text",
complete: function(jqxhr, textstatus) {
var data = jqxhr.responseText;
if (data !== '' && data !== undefined) {
var summary = Search.makeSearchSummary(data, searchterms, hlterms);
if (summary) {
listItem.append(summary);
}
}
Search.output.append(listItem);
setTimeout(function() {
displayNextItem();
}, 5);
}});
} else {
// no source available, just display title
Search.output.append(listItem);
setTimeout(function() {
displayNextItem();
}, 5);
}
}
// search finished, update title and status message
else {
Search.stopPulse();
Search.title.text(_('Search Results'));
if (!resultCount)
Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.'));
else
Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount));
Search.status.fadeIn(500);
}
}
displayNextItem();
},
/**
* search for object names
*/
performObjectSearch : function(object, otherterms) {
var filenames = this._index.filenames;
var docnames = this._index.docnames;
var objects = this._index.objects;
var objnames = this._index.objnames;
var titles = this._index.titles;
var i;
var results = [];
for (var prefix in objects) {
for (var iMatch = 0; iMatch != objects[prefix].length; ++iMatch) {
var match = objects[prefix][iMatch];
var name = match[4];
var fullname = (prefix ? prefix + '.' : '') + name;
var fullnameLower = fullname.toLowerCase()
if (fullnameLower.indexOf(object) > -1) {
var score = 0;
var parts = fullnameLower.split('.');
// check for different match types: exact matches of full name or
// "last name" (i.e. last dotted part)
if (fullnameLower == object || parts[parts.length - 1] == object) {
score += Scorer.objNameMatch;
// matches in last name
} else if (parts[parts.length - 1].indexOf(object) > -1) {
score += Scorer.objPartialMatch;
}
var objname = objnames[match[1]][2];
var title = titles[match[0]];
// If more than one term searched for, we require other words to be
// found in the name/title/description
if (otherterms.length > 0) {
var haystack = (prefix + ' ' + name + ' ' +
objname + ' ' + title).toLowerCase();
var allfound = true;
for (i = 0; i < otherterms.length; i++) {
if (haystack.indexOf(otherterms[i]) == -1) {
allfound = false;
break;
}
}
if (!allfound) {
continue;
}
}
var descr = objname + _(', in ') + title;
var anchor = match[3];
if (anchor === '')
anchor = fullname;
else if (anchor == '-')
anchor = objnames[match[1]][1] + '-' + fullname;
// add custom score for some objects according to scorer
if (Scorer.objPrio.hasOwnProperty(match[2])) {
score += Scorer.objPrio[match[2]];
} else {
score += Scorer.objPrioDefault;
}
results.push([docnames[match[0]], fullname, '#'+anchor, descr, score, filenames[match[0]]]);
}
}
}
return results;
},
/**
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions
*/
escapeRegExp : function(string) {
return string.replace(/[.*+\-?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
},
/**
* search for full-text terms in the index
*/
performTermsSearch : function(searchterms, excluded, terms, titleterms) {
var docnames = this._index.docnames;
var filenames = this._index.filenames;
var titles = this._index.titles;
var i, j, file;
var fileMap = {};
var scoreMap = {};
var results = [];
// perform the search on the required terms
for (i = 0; i < searchterms.length; i++) {
var word = searchterms[i];
var files = [];
var _o = [
{files: terms[word], score: Scorer.term},
{files: titleterms[word], score: Scorer.title}
];
// add support for partial matches
if (word.length > 2) {
var word_regex = this.escapeRegExp(word);
for (var w in terms) {
if (w.match(word_regex) && !terms[word]) {
_o.push({files: terms[w], score: Scorer.partialTerm})
}
}
for (var w in titleterms) {
if (w.match(word_regex) && !titleterms[word]) {
_o.push({files: titleterms[w], score: Scorer.partialTitle})
}
}
}
// no match but word was a required one
if ($u.every(_o, function(o){return o.files === undefined;})) {
break;
}
// found search word in contents
$u.each(_o, function(o) {
var _files = o.files;
if (_files === undefined)
return
if (_files.length === undefined)
_files = [_files];
files = files.concat(_files);
// set score for the word in each file to Scorer.term
for (j = 0; j < _files.length; j++) {
file = _files[j];
if (!(file in scoreMap))
scoreMap[file] = {};
scoreMap[file][word] = o.score;
}
});
// create the mapping
for (j = 0; j < files.length; j++) {
file = files[j];
if (file in fileMap && fileMap[file].indexOf(word) === -1)
fileMap[file].push(word);
else
fileMap[file] = [word];
}
}
// now check if the files don't contain excluded terms
for (file in fileMap) {
var valid = true;
// check if all requirements are matched
var filteredTermCount = // as search terms with length < 3 are discarded: ignore
searchterms.filter(function(term){return term.length > 2}).length
if (
fileMap[file].length != searchterms.length &&
fileMap[file].length != filteredTermCount
) continue;
// ensure that none of the excluded terms is in the search result
for (i = 0; i < excluded.length; i++) {
if (terms[excluded[i]] == file ||
titleterms[excluded[i]] == file ||
$u.contains(terms[excluded[i]] || [], file) ||
$u.contains(titleterms[excluded[i]] || [], file)) {
valid = false;
break;
}
}
// if we have still a valid result we can add it to the result list
if (valid) {
// select one (max) score for the file.
// for better ranking, we should calculate ranking by using words statistics like basic tf-idf...
var score = $u.max($u.map(fileMap[file], function(w){return scoreMap[file][w]}));
results.push([docnames[file], titles[file], '', null, score, filenames[file]]);
}
}
return results;
},
/**
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words, hlwords is the list of normal, unstemmed
* words. the first one is used to find the occurrence, the
* latter for highlighting it.
*/
makeSearchSummary : function(htmlText, keywords, hlwords) {
var text = Search.htmlToText(htmlText);
if (text == "") {
return null;
}
var textLower = text.toLowerCase();
var start = 0;
$.each(keywords, function() {
var i = textLower.indexOf(this.toLowerCase());
if (i > -1)
start = i;
});
start = Math.max(start - 120, 0);
var excerpt = ((start > 0) ? '...' : '') +
$.trim(text.substr(start, 240)) +
((start + 240 - text.length) ? '...' : '');
var rv = $('<p class="context"></p>').text(excerpt);
$.each(hlwords, function() {
rv = rv.highlightText(this, 'highlighted');
});
return rv;
}
};
$(document).ready(function() {
Search.init();
});

2042
docs/html/_static/underscore-1.13.1.js Normal file
View File

File diff suppressed because it is too large Load Diff

6
docs/html/_static/underscore.js Normal file
View File

File diff suppressed because one or more lines are too long

100
docs/html/genindex.html Normal file
View File

@ -0,0 +1,100 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; kittycad v0.0.3 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">kittycad</a></h1>
<h3>Navigation</h3>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2021, KittyCAD Inc..
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>
</body>
</html>

132
docs/html/index.html
View File

@ -1,25 +1,111 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package kittycad</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>kittycad</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/__init__.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/__init__.py</a></font></td></tr></table>
<p><tt>A&nbsp;client&nbsp;library&nbsp;for&nbsp;accessing&nbsp;KittyCAD</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
<!DOCTYPE html>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="kittycad.api.html"><strong>api</strong>&nbsp;(package)</a><br>
</td><td width="25%" valign=top><a href="kittycad.client.html">client</a><br>
</td><td width="25%" valign=top><a href="kittycad.models.html"><strong>models</strong>&nbsp;(package)</a><br>
</td><td width="25%" valign=top><a href="kittycad.types.html">types</a><br>
</td></tr></table></td></tr></table>
</body></html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
<title>Welcome to kittycad’s documentation! &#8212; kittycad v0.0.3 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="welcome-to-kittycad-s-documentation">
<h1>Welcome to kittycad’s documentation!<a class="headerlink" href="#welcome-to-kittycad-s-documentation" title="Permalink to this headline"></a></h1>
<div class="toctree-wrapper compound">
</div>
</section>
<section id="indices-and-tables">
<h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline"></a></h1>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="#">kittycad</a></h1>
<h3>Navigation</h3>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2021, KittyCAD Inc..
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
|
<a href="_sources/index.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>

43
docs/html/kittycad.api.file.file_conversion_by_id.html
View File

@ -1,43 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.api.file.file_conversion_by_id</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.<a href="kittycad.api.file.html"><font color="#ffffff">file</font></a>.file_conversion_by_id</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_conversion_by_id.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_conversion_by_id.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="httpx.html">httpx</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>async <a name="-asyncio"><strong>asyncio</strong></a>(id: str, *, client: kittycad.client.AuthenticatedClient) -&gt; Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]</dt><dd><tt>Get&nbsp;the&nbsp;status&nbsp;of&nbsp;a&nbsp;file&nbsp;conversion.</tt></dd></dl>
<dl><dt>async <a name="-asyncio_detailed"><strong>asyncio_detailed</strong></a>(id: str, *, client: kittycad.client.AuthenticatedClient) -&gt; kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]</dt></dl>
<dl><dt><a name="-sync"><strong>sync</strong></a>(id: str, *, client: kittycad.client.AuthenticatedClient) -&gt; Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]</dt><dd><tt>Get&nbsp;the&nbsp;status&nbsp;of&nbsp;a&nbsp;file&nbsp;conversion.</tt></dd></dl>
<dl><dt><a name="-sync_detailed"><strong>sync_detailed</strong></a>(id: str, *, client: kittycad.client.AuthenticatedClient) -&gt; kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]</dt></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>Any</strong> = typing.Any<br>
<strong>Dict</strong> = typing.Dict<br>
<strong>Optional</strong> = typing.Optional<br>
<strong>Union</strong> = typing.Union</td></tr></table>
</body></html>

43
docs/html/kittycad.api.file.file_convert.html
View File

@ -1,43 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.api.file.file_convert</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.<a href="kittycad.api.file.html"><font color="#ffffff">file</font></a>.file_convert</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_convert.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/file_convert.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="httpx.html">httpx</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>async <a name="-asyncio"><strong>asyncio</strong></a>(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, *, client: kittycad.client.AuthenticatedClient) -&gt; Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]</dt><dd><tt>Convert&nbsp;a&nbsp;CAD&nbsp;file&nbsp;from&nbsp;one&nbsp;format&nbsp;to&nbsp;another.&nbsp;If&nbsp;the&nbsp;file&nbsp;being&nbsp;converted&nbsp;is&nbsp;larger&nbsp;than&nbsp;a&nbsp;certain&nbsp;size&nbsp;it&nbsp;will&nbsp;be&nbsp;performed&nbsp;asynchronously.</tt></dd></dl>
<dl><dt>async <a name="-asyncio_detailed"><strong>asyncio_detailed</strong></a>(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, *, client: kittycad.client.AuthenticatedClient) -&gt; kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]</dt></dl>
<dl><dt><a name="-sync"><strong>sync</strong></a>(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -&gt; Union[Any, kittycad.models.file_conversion.FileConversion, NoneType]</dt><dd><tt>Convert&nbsp;a&nbsp;CAD&nbsp;file&nbsp;from&nbsp;one&nbsp;format&nbsp;to&nbsp;another.&nbsp;If&nbsp;the&nbsp;file&nbsp;being&nbsp;converted&nbsp;is&nbsp;larger&nbsp;than&nbsp;a&nbsp;certain&nbsp;size&nbsp;it&nbsp;will&nbsp;be&nbsp;performed&nbsp;asynchronously.</tt></dd></dl>
<dl><dt><a name="-sync_detailed"><strong>sync_detailed</strong></a>(source_format: kittycad.models.valid_file_types.ValidFileTypes, output_format: kittycad.models.valid_file_types.ValidFileTypes, content: bytes, *, client: kittycad.client.AuthenticatedClient) -&gt; kittycad.types.Response[typing.Union[typing.Any, kittycad.models.file_conversion.FileConversion]]</dt></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>Any</strong> = typing.Any<br>
<strong>Dict</strong> = typing.Dict<br>
<strong>Optional</strong> = typing.Optional<br>
<strong>Union</strong> = typing.Union</td></tr></table>
</body></html>

23
docs/html/kittycad.api.file.html
View File

@ -1,23 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package kittycad.api.file</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.file</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/__init__.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/file/__init__.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="kittycad.api.file.file_conversion_by_id.html">file_conversion_by_id</a><br>
</td><td width="25%" valign=top><a href="kittycad.api.file.file_convert.html">file_convert</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>
</body></html>

23
docs/html/kittycad.api.html
View File

@ -1,23 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package kittycad.api</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.api</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/__init__.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/__init__.py</a></font></td></tr></table>
<p><tt>Contains&nbsp;methods&nbsp;for&nbsp;accessing&nbsp;the&nbsp;API</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="kittycad.api.file.html"><strong>file</strong>&nbsp;(package)</a><br>
</td><td width="25%" valign=top><a href="kittycad.api.meta.html"><strong>meta</strong>&nbsp;(package)</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>
</body></html>

24
docs/html/kittycad.api.meta.html
View File

@ -1,24 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package kittycad.api.meta</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.meta</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/__init__.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/__init__.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="kittycad.api.meta.meta_debug_instance.html">meta_debug_instance</a><br>
</td><td width="25%" valign=top><a href="kittycad.api.meta.meta_debug_session.html">meta_debug_session</a><br>
</td><td width="25%" valign=top><a href="kittycad.api.meta.ping.html">ping</a><br>
</td><td width="25%" valign=top></td></tr></table></td></tr></table>
</body></html>

43
docs/html/kittycad.api.meta.meta_debug_instance.html
View File

@ -1,43 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.api.meta.meta_debug_instance</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.<a href="kittycad.api.meta.html"><font color="#ffffff">meta</font></a>.meta_debug_instance</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/meta_debug_instance.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/meta_debug_instance.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="httpx.html">httpx</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>async <a name="-asyncio"><strong>asyncio</strong></a>(*, client: kittycad.client.AuthenticatedClient) -&gt; Union[Any, kittycad.models.instance_metadata.InstanceMetadata, NoneType]</dt><dd><tt>Get&nbsp;information&nbsp;about&nbsp;this&nbsp;specific&nbsp;API&nbsp;server&nbsp;instance.&nbsp;This&nbsp;is&nbsp;primarily&nbsp;used&nbsp;for&nbsp;debugging.</tt></dd></dl>
<dl><dt>async <a name="-asyncio_detailed"><strong>asyncio_detailed</strong></a>(*, client: kittycad.client.AuthenticatedClient) -&gt; kittycad.types.Response[typing.Union[typing.Any, kittycad.models.instance_metadata.InstanceMetadata]]</dt></dl>
<dl><dt><a name="-sync"><strong>sync</strong></a>(*, client: kittycad.client.AuthenticatedClient) -&gt; Union[Any, kittycad.models.instance_metadata.InstanceMetadata, NoneType]</dt><dd><tt>Get&nbsp;information&nbsp;about&nbsp;this&nbsp;specific&nbsp;API&nbsp;server&nbsp;instance.&nbsp;This&nbsp;is&nbsp;primarily&nbsp;used&nbsp;for&nbsp;debugging.</tt></dd></dl>
<dl><dt><a name="-sync_detailed"><strong>sync_detailed</strong></a>(*, client: kittycad.client.AuthenticatedClient) -&gt; kittycad.types.Response[typing.Union[typing.Any, kittycad.models.instance_metadata.InstanceMetadata]]</dt></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>Any</strong> = typing.Any<br>
<strong>Dict</strong> = typing.Dict<br>
<strong>Optional</strong> = typing.Optional<br>
<strong>Union</strong> = typing.Union</td></tr></table>
</body></html>

43
docs/html/kittycad.api.meta.meta_debug_session.html
View File

@ -1,43 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.api.meta.meta_debug_session</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.<a href="kittycad.api.meta.html"><font color="#ffffff">meta</font></a>.meta_debug_session</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/meta_debug_session.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/meta_debug_session.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="httpx.html">httpx</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>async <a name="-asyncio"><strong>asyncio</strong></a>(*, client: kittycad.client.AuthenticatedClient) -&gt; Union[Any, kittycad.models.auth_session.AuthSession, NoneType]</dt><dd><tt>Get&nbsp;information&nbsp;about&nbsp;your&nbsp;API&nbsp;request&nbsp;session.&nbsp;This&nbsp;is&nbsp;primarily&nbsp;used&nbsp;for&nbsp;debugging.</tt></dd></dl>
<dl><dt>async <a name="-asyncio_detailed"><strong>asyncio_detailed</strong></a>(*, client: kittycad.client.AuthenticatedClient) -&gt; kittycad.types.Response[typing.Union[typing.Any, kittycad.models.auth_session.AuthSession]]</dt></dl>
<dl><dt><a name="-sync"><strong>sync</strong></a>(*, client: kittycad.client.AuthenticatedClient) -&gt; Union[Any, kittycad.models.auth_session.AuthSession, NoneType]</dt><dd><tt>Get&nbsp;information&nbsp;about&nbsp;your&nbsp;API&nbsp;request&nbsp;session.&nbsp;This&nbsp;is&nbsp;primarily&nbsp;used&nbsp;for&nbsp;debugging.</tt></dd></dl>
<dl><dt><a name="-sync_detailed"><strong>sync_detailed</strong></a>(*, client: kittycad.client.AuthenticatedClient) -&gt; kittycad.types.Response[typing.Union[typing.Any, kittycad.models.auth_session.AuthSession]]</dt></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>Any</strong> = typing.Any<br>
<strong>Dict</strong> = typing.Dict<br>
<strong>Optional</strong> = typing.Optional<br>
<strong>Union</strong> = typing.Union</td></tr></table>
</body></html>

42
docs/html/kittycad.api.meta.ping.html
View File

@ -1,42 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.api.meta.ping</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.api.html"><font color="#ffffff">api</font></a>.<a href="kittycad.api.meta.html"><font color="#ffffff">meta</font></a>.ping</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/ping.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/api/meta/ping.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="httpx.html">httpx</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#eeaa77">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
<tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl><dt>async <a name="-asyncio"><strong>asyncio</strong></a>(*, client: kittycad.client.Client) -&gt; Optional[kittycad.models.message.Message]</dt><dd><tt>Simple&nbsp;ping&nbsp;to&nbsp;the&nbsp;server.</tt></dd></dl>
<dl><dt>async <a name="-asyncio_detailed"><strong>asyncio_detailed</strong></a>(*, client: kittycad.client.Client) -&gt; kittycad.types.Response[kittycad.models.message.Message]</dt></dl>
<dl><dt><a name="-sync"><strong>sync</strong></a>(*, client: kittycad.client.Client) -&gt; Optional[kittycad.models.message.Message]</dt><dd><tt>Simple&nbsp;ping&nbsp;to&nbsp;the&nbsp;server.</tt></dd></dl>
<dl><dt><a name="-sync_detailed"><strong>sync_detailed</strong></a>(*, client: kittycad.client.Client) -&gt; kittycad.types.Response[kittycad.models.message.Message]</dt></dl>
</td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>Any</strong> = typing.Any<br>
<strong>Dict</strong> = typing.Dict<br>
<strong>Optional</strong> = typing.Optional</td></tr></table>
</body></html>

171
docs/html/kittycad.client.html
View File

@ -1,171 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.client</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.client</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/client.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/client.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
</td><td width="25%" valign=top><a href="ssl.html">ssl</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.client.html#Client">Client</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.client.html#AuthenticatedClient">AuthenticatedClient</a>
</font></dt></dl>
</dd>
</dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="AuthenticatedClient">class <strong>AuthenticatedClient</strong></a>(<a href="kittycad.client.html#Client">Client</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#AuthenticatedClient">AuthenticatedClient</a>(base_url:&nbsp;str&nbsp;=&nbsp;'<a href="https://api.kittycad.io">https://api.kittycad.io</a>',&nbsp;*,&nbsp;cookies:&nbsp;Dict[str,&nbsp;str]&nbsp;=&nbsp;NOTHING,&nbsp;headers:&nbsp;Dict[str,&nbsp;str]&nbsp;=&nbsp;NOTHING,&nbsp;timeout:&nbsp;float&nbsp;=&nbsp;5.0,&nbsp;verify_ssl:&nbsp;Union[str,&nbsp;bool,&nbsp;ssl.SSLContext]&nbsp;=&nbsp;True,&nbsp;token:&nbsp;str)&nbsp;-&amp;gt;&nbsp;None<br>
&nbsp;<br>
A&nbsp;<a href="#Client">Client</a>&nbsp;which&nbsp;has&nbsp;been&nbsp;authenticated&nbsp;for&nbsp;use&nbsp;on&nbsp;secured&nbsp;endpoints<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="kittycad.client.html#AuthenticatedClient">AuthenticatedClient</a></dd>
<dd><a href="kittycad.client.html#Client">Client</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="AuthenticatedClient-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
<dl><dt><a name="AuthenticatedClient-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
<dl><dt><a name="AuthenticatedClient-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
<dl><dt><a name="AuthenticatedClient-__init__"><strong>__init__</strong></a>(self, base_url: str = 'https://api.kittycad.io', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True, token: str) -&gt; None</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
<dl><dt><a name="AuthenticatedClient-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
<dl><dt><a name="AuthenticatedClient-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
<dl><dt><a name="AuthenticatedClient-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
<dl><dt><a name="AuthenticatedClient-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthenticatedClient">AuthenticatedClient</a>.</tt></dd></dl>
<dl><dt><a name="AuthenticatedClient-get_headers"><strong>get_headers</strong></a>(self) -&gt; Dict[str, str]</dt><dd><tt>Get&nbsp;headers&nbsp;to&nbsp;be&nbsp;used&nbsp;in&nbsp;authenticated&nbsp;endpoints</tt></dd></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__annotations__</strong> = {'token': &lt;class 'str'&gt;}</dl>
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='base_url', default='https://api... kw_only=True, inherited=False, on_setattr=None))</dl>
<dl><dt><strong>__hash__</strong> = None</dl>
<hr>
Methods inherited from <a href="kittycad.client.html#Client">Client</a>:<br>
<dl><dt><a name="AuthenticatedClient-get_cookies"><strong>get_cookies</strong></a>(self) -&gt; Dict[str, str]</dt></dl>
<dl><dt><a name="AuthenticatedClient-get_timeout"><strong>get_timeout</strong></a>(self) -&gt; float</dt></dl>
<dl><dt><a name="AuthenticatedClient-with_cookies"><strong>with_cookies</strong></a>(self, cookies: Dict[str, str]) -&gt; 'Client'</dt><dd><tt>Get&nbsp;a&nbsp;new&nbsp;client&nbsp;matching&nbsp;this&nbsp;one&nbsp;with&nbsp;additional&nbsp;cookies</tt></dd></dl>
<dl><dt><a name="AuthenticatedClient-with_headers"><strong>with_headers</strong></a>(self, headers: Dict[str, str]) -&gt; 'Client'</dt><dd><tt>Get&nbsp;a&nbsp;new&nbsp;client&nbsp;matching&nbsp;this&nbsp;one&nbsp;with&nbsp;additional&nbsp;headers</tt></dd></dl>
<dl><dt><a name="AuthenticatedClient-with_timeout"><strong>with_timeout</strong></a>(self, timeout: float) -&gt; 'Client'</dt><dd><tt>Get&nbsp;a&nbsp;new&nbsp;client&nbsp;matching&nbsp;this&nbsp;one&nbsp;with&nbsp;a&nbsp;new&nbsp;timeout&nbsp;(in&nbsp;seconds)</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="kittycad.client.html#Client">Client</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Client">class <strong>Client</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#Client">Client</a>(base_url:&nbsp;str&nbsp;=&nbsp;'<a href="https://api.kittycad.io">https://api.kittycad.io</a>',&nbsp;*,&nbsp;cookies:&nbsp;Dict[str,&nbsp;str]&nbsp;=&nbsp;NOTHING,&nbsp;headers:&nbsp;Dict[str,&nbsp;str]&nbsp;=&nbsp;NOTHING,&nbsp;timeout:&nbsp;float&nbsp;=&nbsp;5.0,&nbsp;verify_ssl:&nbsp;Union[str,&nbsp;bool,&nbsp;ssl.SSLContext]&nbsp;=&nbsp;True)&nbsp;-&amp;gt;&nbsp;None<br>
&nbsp;<br>
A&nbsp;class&nbsp;for&nbsp;keeping&nbsp;track&nbsp;of&nbsp;data&nbsp;related&nbsp;to&nbsp;the&nbsp;API<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Client-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Client">Client</a>.</tt></dd></dl>
<dl><dt><a name="Client-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Client">Client</a>.</tt></dd></dl>
<dl><dt><a name="Client-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Client">Client</a>.</tt></dd></dl>
<dl><dt><a name="Client-__init__"><strong>__init__</strong></a>(self, base_url: str = 'https://api.kittycad.io', *, cookies: Dict[str, str] = NOTHING, headers: Dict[str, str] = NOTHING, timeout: float = 5.0, verify_ssl: Union[str, bool, ssl.SSLContext] = True) -&gt; None</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Client">Client</a>.</tt></dd></dl>
<dl><dt><a name="Client-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Client">Client</a>.</tt></dd></dl>
<dl><dt><a name="Client-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Client">Client</a>.</tt></dd></dl>
<dl><dt><a name="Client-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Client">Client</a>.</tt></dd></dl>
<dl><dt><a name="Client-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Client">Client</a>.</tt></dd></dl>
<dl><dt><a name="Client-get_cookies"><strong>get_cookies</strong></a>(self) -&gt; Dict[str, str]</dt></dl>
<dl><dt><a name="Client-get_headers"><strong>get_headers</strong></a>(self) -&gt; Dict[str, str]</dt><dd><tt>Get&nbsp;headers&nbsp;to&nbsp;be&nbsp;used&nbsp;in&nbsp;all&nbsp;endpoints</tt></dd></dl>
<dl><dt><a name="Client-get_timeout"><strong>get_timeout</strong></a>(self) -&gt; float</dt></dl>
<dl><dt><a name="Client-with_cookies"><strong>with_cookies</strong></a>(self, cookies: Dict[str, str]) -&gt; 'Client'</dt><dd><tt>Get&nbsp;a&nbsp;new&nbsp;client&nbsp;matching&nbsp;this&nbsp;one&nbsp;with&nbsp;additional&nbsp;cookies</tt></dd></dl>
<dl><dt><a name="Client-with_headers"><strong>with_headers</strong></a>(self, headers: Dict[str, str]) -&gt; 'Client'</dt><dd><tt>Get&nbsp;a&nbsp;new&nbsp;client&nbsp;matching&nbsp;this&nbsp;one&nbsp;with&nbsp;additional&nbsp;headers</tt></dd></dl>
<dl><dt><a name="Client-with_timeout"><strong>with_timeout</strong></a>(self, timeout: float) -&gt; 'Client'</dt><dd><tt>Get&nbsp;a&nbsp;new&nbsp;client&nbsp;matching&nbsp;this&nbsp;one&nbsp;with&nbsp;a&nbsp;new&nbsp;timeout&nbsp;(in&nbsp;seconds)</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__annotations__</strong> = {'base_url': &lt;class 'str'&gt;, 'cookies': typing.Dict[str, str], 'headers': typing.Dict[str, str], 'timeout': &lt;class 'float'&gt;, 'verify_ssl': typing.Union[str, bool, ssl.SSLContext]}</dl>
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='base_url', default='https://api... kw_only=True, inherited=False, on_setattr=None))</dl>
<dl><dt><strong>__hash__</strong> = None</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>Dict</strong> = typing.Dict<br>
<strong>Union</strong> = typing.Union</td></tr></table>
</body></html>

113
docs/html/kittycad.models.auth_session.html
View File

@ -1,113 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.models.auth_session</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.auth_session</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/auth_session.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/auth_session.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
</td><td width="25%" valign=top><a href="datetime.html">datetime</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.models.auth_session.html#AuthSession">AuthSession</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="AuthSession">class <strong>AuthSession</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#AuthSession">AuthSession</a>(created_at:&nbsp;Union[kittycad.types.Unset,&nbsp;datetime.datetime]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd2cbf1ddb0&amp;gt;,&nbsp;email:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd2cbf1ddb0&amp;gt;,&nbsp;id:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd2cbf1ddb0&amp;gt;,&nbsp;ip_address:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd2cbf1ddb0&amp;gt;,&nbsp;is_valid:&nbsp;Union[kittycad.types.Unset,&nbsp;bool]&nbsp;=&nbsp;False,&nbsp;token:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd2cbf1ddb0&amp;gt;,&nbsp;user_id:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd2cbf1ddb0&amp;gt;)&nbsp;-&amp;gt;&nbsp;None<br>
&nbsp;<br>
<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="AuthSession-__contains__"><strong>__contains__</strong></a>(self, key: str) -&gt; bool</dt></dl>
<dl><dt><a name="AuthSession-__delitem__"><strong>__delitem__</strong></a>(self, key: str) -&gt; None</dt></dl>
<dl><dt><a name="AuthSession-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
<dl><dt><a name="AuthSession-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
<dl><dt><a name="AuthSession-__getitem__"><strong>__getitem__</strong></a>(self, key: str) -&gt; Any</dt></dl>
<dl><dt><a name="AuthSession-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
<dl><dt><a name="AuthSession-__init__"><strong>__init__</strong></a>(self, created_at: Union[kittycad.types.Unset, datetime.datetime] = &lt;kittycad.types.Unset object at 0x7fd2cbf1ddb0&gt;, email: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd2cbf1ddb0&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd2cbf1ddb0&gt;, ip_address: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd2cbf1ddb0&gt;, is_valid: Union[kittycad.types.Unset, bool] = False, token: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd2cbf1ddb0&gt;, user_id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd2cbf1ddb0&gt;) -&gt; None</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
<dl><dt><a name="AuthSession-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
<dl><dt><a name="AuthSession-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
<dl><dt><a name="AuthSession-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
<dl><dt><a name="AuthSession-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#AuthSession">AuthSession</a>.</tt></dd></dl>
<dl><dt><a name="AuthSession-__setitem__"><strong>__setitem__</strong></a>(self, key: str, value: Any) -&gt; None</dt></dl>
<dl><dt><a name="AuthSession-to_dict"><strong>to_dict</strong></a>(self) -&gt; Dict[str, Any]</dt></dl>
<hr>
Class methods defined here:<br>
<dl><dt><a name="AuthSession-from_dict"><strong>from_dict</strong></a>(src_dict: Dict[str, Any]) -&gt; ~T<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
<hr>
Readonly properties defined here:<br>
<dl><dt><strong>additional_keys</strong></dt>
</dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__annotations__</strong> = {'additional_properties': typing.Dict[str, typing.Any], 'created_at': typing.Union[kittycad.types.Unset, datetime.datetime], 'email': typing.Union[kittycad.types.Unset, str], 'id': typing.Union[kittycad.types.Unset, str], 'ip_address': typing.Union[kittycad.types.Unset, str], 'is_valid': typing.Union[kittycad.types.Unset, bool], 'token': typing.Union[kittycad.types.Unset, str], 'user_id': typing.Union[kittycad.types.Unset, str]}</dl>
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='created_at', default=&lt;kittycad....kw_only=False, inherited=False, on_setattr=None))</dl>
<dl><dt><strong>__hash__</strong> = None</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>Any</strong> = typing.Any<br>
<strong>Dict</strong> = typing.Dict<br>
<strong>List</strong> = typing.List<br>
<strong>T</strong> = ~T<br>
<strong>Type</strong> = typing.Type<br>
<strong>UNSET</strong> = &lt;kittycad.types.Unset object&gt;<br>
<strong>Union</strong> = typing.Union</td></tr></table>
</body></html>

76
docs/html/kittycad.models.environment.html
View File

@ -1,76 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.models.environment</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.environment</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/environment.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/environment.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#str">builtins.str</a>(<a href="builtins.html#object">builtins.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.models.environment.html#Environment">Environment</a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="enum.html#Enum">enum.Enum</a>(<a href="builtins.html#object">builtins.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.models.environment.html#Environment">Environment</a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Environment">class <strong>Environment</strong></a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#Environment">Environment</a>(value,&nbsp;names=None,&nbsp;*,&nbsp;module=None,&nbsp;qualname=None,&nbsp;type=None,&nbsp;start=1)<br>
&nbsp;<br>
An&nbsp;enumeration.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="kittycad.models.environment.html#Environment">Environment</a></dd>
<dd><a href="builtins.html#str">builtins.str</a></dd>
<dd><a href="enum.html#Enum">enum.Enum</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>DEVELOPMENT</strong> = &lt;Environment.DEVELOPMENT: 'DEVELOPMENT'&gt;</dl>
<dl><dt><strong>PREVIEW</strong> = &lt;Environment.PREVIEW: 'PREVIEW'&gt;</dl>
<dl><dt><strong>PRODUCTION</strong> = &lt;Environment.PRODUCTION: 'PRODUCTION'&gt;</dl>
<hr>
Data descriptors inherited from <a href="enum.html#Enum">enum.Enum</a>:<br>
<dl><dt><strong>name</strong></dt>
<dd><tt>The&nbsp;name&nbsp;of&nbsp;the&nbsp;Enum&nbsp;member.</tt></dd>
</dl>
<dl><dt><strong>value</strong></dt>
<dd><tt>The&nbsp;value&nbsp;of&nbsp;the&nbsp;Enum&nbsp;member.</tt></dd>
</dl>
<hr>
Readonly properties inherited from <a href="enum.html#EnumMeta">enum.EnumMeta</a>:<br>
<dl><dt><strong>__members__</strong></dt>
<dd><tt>Returns&nbsp;a&nbsp;mapping&nbsp;of&nbsp;member&nbsp;name-&gt;value.<br>
&nbsp;<br>
This&nbsp;mapping&nbsp;lists&nbsp;all&nbsp;enum&nbsp;members,&nbsp;including&nbsp;aliases.&nbsp;Note&nbsp;that&nbsp;this<br>
is&nbsp;a&nbsp;read-only&nbsp;view&nbsp;of&nbsp;the&nbsp;internal&nbsp;mapping.</tt></dd>
</dl>
</td></tr></table></td></tr></table>
</body></html>

112
docs/html/kittycad.models.error_message.html
View File

@ -1,112 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.models.error_message</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.error_message</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/error_message.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/error_message.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.models.error_message.html#ErrorMessage">ErrorMessage</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="ErrorMessage">class <strong>ErrorMessage</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#ErrorMessage">ErrorMessage</a>(message:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7f36b5e59de0&amp;gt;)&nbsp;-&amp;gt;&nbsp;None<br>
&nbsp;<br>
<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="ErrorMessage-__contains__"><strong>__contains__</strong></a>(self, key: str) -&gt; bool</dt></dl>
<dl><dt><a name="ErrorMessage-__delitem__"><strong>__delitem__</strong></a>(self, key: str) -&gt; None</dt></dl>
<dl><dt><a name="ErrorMessage-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
<dl><dt><a name="ErrorMessage-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
<dl><dt><a name="ErrorMessage-__getitem__"><strong>__getitem__</strong></a>(self, key: str) -&gt; Any</dt></dl>
<dl><dt><a name="ErrorMessage-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
<dl><dt><a name="ErrorMessage-__init__"><strong>__init__</strong></a>(self, message: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f36b5e59de0&gt;) -&gt; None</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
<dl><dt><a name="ErrorMessage-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
<dl><dt><a name="ErrorMessage-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
<dl><dt><a name="ErrorMessage-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
<dl><dt><a name="ErrorMessage-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#ErrorMessage">ErrorMessage</a>.</tt></dd></dl>
<dl><dt><a name="ErrorMessage-__setitem__"><strong>__setitem__</strong></a>(self, key: str, value: Any) -&gt; None</dt></dl>
<dl><dt><a name="ErrorMessage-to_dict"><strong>to_dict</strong></a>(self) -&gt; Dict[str, Any]</dt></dl>
<hr>
Class methods defined here:<br>
<dl><dt><a name="ErrorMessage-from_dict"><strong>from_dict</strong></a>(src_dict: Dict[str, Any]) -&gt; ~T<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
<hr>
Readonly properties defined here:<br>
<dl><dt><strong>additional_keys</strong></dt>
</dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__annotations__</strong> = {'additional_properties': typing.Dict[str, typing.Any], 'message': typing.Union[kittycad.types.Unset, str]}</dl>
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='message', default=&lt;kittycad.typ...kw_only=False, inherited=False, on_setattr=None))</dl>
<dl><dt><strong>__hash__</strong> = None</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>Any</strong> = typing.Any<br>
<strong>Dict</strong> = typing.Dict<br>
<strong>List</strong> = typing.List<br>
<strong>T</strong> = ~T<br>
<strong>Type</strong> = typing.Type<br>
<strong>UNSET</strong> = &lt;kittycad.types.Unset object&gt;<br>
<strong>Union</strong> = typing.Union</td></tr></table>
</body></html>

113
docs/html/kittycad.models.file_conversion.html
View File

@ -1,113 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.models.file_conversion</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.file_conversion</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/file_conversion.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/file_conversion.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
</td><td width="25%" valign=top><a href="datetime.html">datetime</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.models.file_conversion.html#FileConversion">FileConversion</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FileConversion">class <strong>FileConversion</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#FileConversion">FileConversion</a>(completed_at:&nbsp;Union[kittycad.types.Unset,&nbsp;datetime.datetime]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7f6b204d9de0&amp;gt;,&nbsp;created_at:&nbsp;Union[kittycad.types.Unset,&nbsp;datetime.datetime]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7f6b204d9de0&amp;gt;,&nbsp;id:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7f6b204d9de0&amp;gt;,&nbsp;output:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7f6b204d9de0&amp;gt;,&nbsp;output_format:&nbsp;Union[kittycad.types.Unset,&nbsp;kittycad.models.valid_file_types.ValidFileTypes]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7f6b204d9de0&amp;gt;,&nbsp;src_format:&nbsp;Union[kittycad.types.Unset,&nbsp;kittycad.models.valid_file_types.ValidFileTypes]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7f6b204d9de0&amp;gt;,&nbsp;status:&nbsp;Union[kittycad.types.Unset,&nbsp;kittycad.models.file_conversion_status.FileConversionStatus]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7f6b204d9de0&amp;gt;)&nbsp;-&amp;gt;&nbsp;None<br>
&nbsp;<br>
<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="FileConversion-__contains__"><strong>__contains__</strong></a>(self, key: str) -&gt; bool</dt></dl>
<dl><dt><a name="FileConversion-__delitem__"><strong>__delitem__</strong></a>(self, key: str) -&gt; None</dt></dl>
<dl><dt><a name="FileConversion-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
<dl><dt><a name="FileConversion-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
<dl><dt><a name="FileConversion-__getitem__"><strong>__getitem__</strong></a>(self, key: str) -&gt; Any</dt></dl>
<dl><dt><a name="FileConversion-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
<dl><dt><a name="FileConversion-__init__"><strong>__init__</strong></a>(self, completed_at: Union[kittycad.types.Unset, datetime.datetime] = &lt;kittycad.types.Unset object at 0x7f6b204d9de0&gt;, created_at: Union[kittycad.types.Unset, datetime.datetime] = &lt;kittycad.types.Unset object at 0x7f6b204d9de0&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f6b204d9de0&gt;, output: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f6b204d9de0&gt;, output_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = &lt;kittycad.types.Unset object at 0x7f6b204d9de0&gt;, src_format: Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes] = &lt;kittycad.types.Unset object at 0x7f6b204d9de0&gt;, status: Union[kittycad.types.Unset, kittycad.models.file_conversion_status.FileConversionStatus] = &lt;kittycad.types.Unset object at 0x7f6b204d9de0&gt;) -&gt; None</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
<dl><dt><a name="FileConversion-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
<dl><dt><a name="FileConversion-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
<dl><dt><a name="FileConversion-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
<dl><dt><a name="FileConversion-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#FileConversion">FileConversion</a>.</tt></dd></dl>
<dl><dt><a name="FileConversion-__setitem__"><strong>__setitem__</strong></a>(self, key: str, value: Any) -&gt; None</dt></dl>
<dl><dt><a name="FileConversion-to_dict"><strong>to_dict</strong></a>(self) -&gt; Dict[str, Any]</dt></dl>
<hr>
Class methods defined here:<br>
<dl><dt><a name="FileConversion-from_dict"><strong>from_dict</strong></a>(src_dict: Dict[str, Any]) -&gt; ~T<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
<hr>
Readonly properties defined here:<br>
<dl><dt><strong>additional_keys</strong></dt>
</dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__annotations__</strong> = {'additional_properties': typing.Dict[str, typing.Any], 'completed_at': typing.Union[kittycad.types.Unset, datetime.datetime], 'created_at': typing.Union[kittycad.types.Unset, datetime.datetime], 'id': typing.Union[kittycad.types.Unset, str], 'output': typing.Union[kittycad.types.Unset, str], 'output_format': typing.Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes], 'src_format': typing.Union[kittycad.types.Unset, kittycad.models.valid_file_types.ValidFileTypes], 'status': typing.Union[kittycad.types.Unset, kittycad.models.file_conversion_status.FileConversionStatus]}</dl>
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='completed_at', default=&lt;kittyca...kw_only=False, inherited=False, on_setattr=None))</dl>
<dl><dt><strong>__hash__</strong> = None</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>Any</strong> = typing.Any<br>
<strong>Dict</strong> = typing.Dict<br>
<strong>List</strong> = typing.List<br>
<strong>T</strong> = ~T<br>
<strong>Type</strong> = typing.Type<br>
<strong>UNSET</strong> = &lt;kittycad.types.Unset object&gt;<br>
<strong>Union</strong> = typing.Union</td></tr></table>
</body></html>

80
docs/html/kittycad.models.file_conversion_status.html
View File

@ -1,80 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.models.file_conversion_status</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.file_conversion_status</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/file_conversion_status.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/file_conversion_status.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#str">builtins.str</a>(<a href="builtins.html#object">builtins.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.models.file_conversion_status.html#FileConversionStatus">FileConversionStatus</a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="enum.html#Enum">enum.Enum</a>(<a href="builtins.html#object">builtins.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.models.file_conversion_status.html#FileConversionStatus">FileConversionStatus</a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="FileConversionStatus">class <strong>FileConversionStatus</strong></a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#FileConversionStatus">FileConversionStatus</a>(value,&nbsp;names=None,&nbsp;*,&nbsp;module=None,&nbsp;qualname=None,&nbsp;type=None,&nbsp;start=1)<br>
&nbsp;<br>
An&nbsp;enumeration.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="kittycad.models.file_conversion_status.html#FileConversionStatus">FileConversionStatus</a></dd>
<dd><a href="builtins.html#str">builtins.str</a></dd>
<dd><a href="enum.html#Enum">enum.Enum</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>COMPLETED</strong> = &lt;FileConversionStatus.COMPLETED: 'Completed'&gt;</dl>
<dl><dt><strong>FAILED</strong> = &lt;FileConversionStatus.FAILED: 'Failed'&gt;</dl>
<dl><dt><strong>IN_PROGRESS</strong> = &lt;FileConversionStatus.IN_PROGRESS: 'In Progress'&gt;</dl>
<dl><dt><strong>QUEUED</strong> = &lt;FileConversionStatus.QUEUED: 'Queued'&gt;</dl>
<dl><dt><strong>UPLOADED</strong> = &lt;FileConversionStatus.UPLOADED: 'Uploaded'&gt;</dl>
<hr>
Data descriptors inherited from <a href="enum.html#Enum">enum.Enum</a>:<br>
<dl><dt><strong>name</strong></dt>
<dd><tt>The&nbsp;name&nbsp;of&nbsp;the&nbsp;Enum&nbsp;member.</tt></dd>
</dl>
<dl><dt><strong>value</strong></dt>
<dd><tt>The&nbsp;value&nbsp;of&nbsp;the&nbsp;Enum&nbsp;member.</tt></dd>
</dl>
<hr>
Readonly properties inherited from <a href="enum.html#EnumMeta">enum.EnumMeta</a>:<br>
<dl><dt><strong>__members__</strong></dt>
<dd><tt>Returns&nbsp;a&nbsp;mapping&nbsp;of&nbsp;member&nbsp;name-&gt;value.<br>
&nbsp;<br>
This&nbsp;mapping&nbsp;lists&nbsp;all&nbsp;enum&nbsp;members,&nbsp;including&nbsp;aliases.&nbsp;Note&nbsp;that&nbsp;this<br>
is&nbsp;a&nbsp;read-only&nbsp;view&nbsp;of&nbsp;the&nbsp;internal&nbsp;mapping.</tt></dd>
</dl>
</td></tr></table></td></tr></table>
</body></html>

29
docs/html/kittycad.models.html
View File

@ -1,29 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: package kittycad.models</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.models</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/__init__.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/__init__.py</a></font></td></tr></table>
<p><tt>Contains&nbsp;all&nbsp;the&nbsp;data&nbsp;models&nbsp;used&nbsp;in&nbsp;inputs/outputs</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="kittycad.models.auth_session.html">auth_session</a><br>
<a href="kittycad.models.environment.html">environment</a><br>
</td><td width="25%" valign=top><a href="kittycad.models.error_message.html">error_message</a><br>
<a href="kittycad.models.file_conversion.html">file_conversion</a><br>
</td><td width="25%" valign=top><a href="kittycad.models.file_conversion_status.html">file_conversion_status</a><br>
<a href="kittycad.models.instance_metadata.html">instance_metadata</a><br>
</td><td width="25%" valign=top><a href="kittycad.models.message.html">message</a><br>
<a href="kittycad.models.valid_file_types.html">valid_file_types</a><br>
</td></tr></table></td></tr></table>
</body></html>

112
docs/html/kittycad.models.instance_metadata.html
View File

@ -1,112 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.models.instance_metadata</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.instance_metadata</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/instance_metadata.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/instance_metadata.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.models.instance_metadata.html#InstanceMetadata">InstanceMetadata</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="InstanceMetadata">class <strong>InstanceMetadata</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#InstanceMetadata">InstanceMetadata</a>(cpu_platform:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd00a5cdd80&amp;gt;,&nbsp;description:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd00a5cdd80&amp;gt;,&nbsp;environment:&nbsp;Union[kittycad.types.Unset,&nbsp;kittycad.models.environment.Environment]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd00a5cdd80&amp;gt;,&nbsp;git_hash:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd00a5cdd80&amp;gt;,&nbsp;hostname:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd00a5cdd80&amp;gt;,&nbsp;id:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd00a5cdd80&amp;gt;,&nbsp;image:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd00a5cdd80&amp;gt;,&nbsp;ip_address:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd00a5cdd80&amp;gt;,&nbsp;machine_type:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd00a5cdd80&amp;gt;,&nbsp;name:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd00a5cdd80&amp;gt;,&nbsp;zone:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7fd00a5cdd80&amp;gt;)&nbsp;-&amp;gt;&nbsp;None<br>
&nbsp;<br>
<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="InstanceMetadata-__contains__"><strong>__contains__</strong></a>(self, key: str) -&gt; bool</dt></dl>
<dl><dt><a name="InstanceMetadata-__delitem__"><strong>__delitem__</strong></a>(self, key: str) -&gt; None</dt></dl>
<dl><dt><a name="InstanceMetadata-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
<dl><dt><a name="InstanceMetadata-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
<dl><dt><a name="InstanceMetadata-__getitem__"><strong>__getitem__</strong></a>(self, key: str) -&gt; Any</dt></dl>
<dl><dt><a name="InstanceMetadata-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
<dl><dt><a name="InstanceMetadata-__init__"><strong>__init__</strong></a>(self, cpu_platform: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, description: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, environment: Union[kittycad.types.Unset, kittycad.models.environment.Environment] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, git_hash: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, hostname: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, id: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, image: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, ip_address: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, machine_type: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, name: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;, zone: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7fd00a5cdd80&gt;) -&gt; None</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
<dl><dt><a name="InstanceMetadata-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
<dl><dt><a name="InstanceMetadata-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
<dl><dt><a name="InstanceMetadata-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
<dl><dt><a name="InstanceMetadata-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#InstanceMetadata">InstanceMetadata</a>.</tt></dd></dl>
<dl><dt><a name="InstanceMetadata-__setitem__"><strong>__setitem__</strong></a>(self, key: str, value: Any) -&gt; None</dt></dl>
<dl><dt><a name="InstanceMetadata-to_dict"><strong>to_dict</strong></a>(self) -&gt; Dict[str, Any]</dt></dl>
<hr>
Class methods defined here:<br>
<dl><dt><a name="InstanceMetadata-from_dict"><strong>from_dict</strong></a>(src_dict: Dict[str, Any]) -&gt; ~T<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
<hr>
Readonly properties defined here:<br>
<dl><dt><strong>additional_keys</strong></dt>
</dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__annotations__</strong> = {'additional_properties': typing.Dict[str, typing.Any], 'cpu_platform': typing.Union[kittycad.types.Unset, str], 'description': typing.Union[kittycad.types.Unset, str], 'environment': typing.Union[kittycad.types.Unset, kittycad.models.environment.Environment], 'git_hash': typing.Union[kittycad.types.Unset, str], 'hostname': typing.Union[kittycad.types.Unset, str], 'id': typing.Union[kittycad.types.Unset, str], 'image': typing.Union[kittycad.types.Unset, str], 'ip_address': typing.Union[kittycad.types.Unset, str], 'machine_type': typing.Union[kittycad.types.Unset, str], ...}</dl>
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='cpu_platform', default=&lt;kittyca...kw_only=False, inherited=False, on_setattr=None))</dl>
<dl><dt><strong>__hash__</strong> = None</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>Any</strong> = typing.Any<br>
<strong>Dict</strong> = typing.Dict<br>
<strong>List</strong> = typing.List<br>
<strong>T</strong> = ~T<br>
<strong>Type</strong> = typing.Type<br>
<strong>UNSET</strong> = &lt;kittycad.types.Unset object&gt;<br>
<strong>Union</strong> = typing.Union</td></tr></table>
</body></html>

112
docs/html/kittycad.models.message.html
View File

@ -1,112 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.models.message</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.message</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/message.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/message.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.models.message.html#Message">Message</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Message">class <strong>Message</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#Message">Message</a>(message:&nbsp;Union[kittycad.types.Unset,&nbsp;str]&nbsp;=&nbsp;&amp;lt;kittycad.types.Unset&nbsp;<a href="builtins.html#object">object</a>&nbsp;at&nbsp;0x7f4b3f289d50&amp;gt;)&nbsp;-&amp;gt;&nbsp;None<br>
&nbsp;<br>
<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Message-__contains__"><strong>__contains__</strong></a>(self, key: str) -&gt; bool</dt></dl>
<dl><dt><a name="Message-__delitem__"><strong>__delitem__</strong></a>(self, key: str) -&gt; None</dt></dl>
<dl><dt><a name="Message-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Message">Message</a>.</tt></dd></dl>
<dl><dt><a name="Message-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Message">Message</a>.</tt></dd></dl>
<dl><dt><a name="Message-__getitem__"><strong>__getitem__</strong></a>(self, key: str) -&gt; Any</dt></dl>
<dl><dt><a name="Message-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Message">Message</a>.</tt></dd></dl>
<dl><dt><a name="Message-__init__"><strong>__init__</strong></a>(self, message: Union[kittycad.types.Unset, str] = &lt;kittycad.types.Unset object at 0x7f4b3f289d50&gt;) -&gt; None</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Message">Message</a>.</tt></dd></dl>
<dl><dt><a name="Message-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Message">Message</a>.</tt></dd></dl>
<dl><dt><a name="Message-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Message">Message</a>.</tt></dd></dl>
<dl><dt><a name="Message-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Message">Message</a>.</tt></dd></dl>
<dl><dt><a name="Message-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Message">Message</a>.</tt></dd></dl>
<dl><dt><a name="Message-__setitem__"><strong>__setitem__</strong></a>(self, key: str, value: Any) -&gt; None</dt></dl>
<dl><dt><a name="Message-to_dict"><strong>to_dict</strong></a>(self) -&gt; Dict[str, Any]</dt></dl>
<hr>
Class methods defined here:<br>
<dl><dt><a name="Message-from_dict"><strong>from_dict</strong></a>(src_dict: Dict[str, Any]) -&gt; ~T<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
<hr>
Readonly properties defined here:<br>
<dl><dt><strong>additional_keys</strong></dt>
</dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__annotations__</strong> = {'additional_properties': typing.Dict[str, typing.Any], 'message': typing.Union[kittycad.types.Unset, str]}</dl>
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='message', default=&lt;kittycad.typ...kw_only=False, inherited=False, on_setattr=None))</dl>
<dl><dt><strong>__hash__</strong> = None</dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>Any</strong> = typing.Any<br>
<strong>Dict</strong> = typing.Dict<br>
<strong>List</strong> = typing.List<br>
<strong>T</strong> = ~T<br>
<strong>Type</strong> = typing.Type<br>
<strong>UNSET</strong> = &lt;kittycad.types.Unset object&gt;<br>
<strong>Union</strong> = typing.Union</td></tr></table>
</body></html>

80
docs/html/kittycad.models.valid_file_types.html
View File

@ -1,80 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.models.valid_file_types</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.<a href="kittycad.models.html"><font color="#ffffff">models</font></a>.valid_file_types</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/models/valid_file_types.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/models/valid_file_types.py</a></font></td></tr></table>
<p></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#str">builtins.str</a>(<a href="builtins.html#object">builtins.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.models.valid_file_types.html#ValidFileTypes">ValidFileTypes</a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="enum.html#Enum">enum.Enum</a>(<a href="builtins.html#object">builtins.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.models.valid_file_types.html#ValidFileTypes">ValidFileTypes</a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="ValidFileTypes">class <strong>ValidFileTypes</strong></a>(<a href="builtins.html#str">builtins.str</a>, <a href="enum.html#Enum">enum.Enum</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#ValidFileTypes">ValidFileTypes</a>(value,&nbsp;names=None,&nbsp;*,&nbsp;module=None,&nbsp;qualname=None,&nbsp;type=None,&nbsp;start=1)<br>
&nbsp;<br>
An&nbsp;enumeration.<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="kittycad.models.valid_file_types.html#ValidFileTypes">ValidFileTypes</a></dd>
<dd><a href="builtins.html#str">builtins.str</a></dd>
<dd><a href="enum.html#Enum">enum.Enum</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>DWG</strong> = &lt;ValidFileTypes.DWG: 'dwg'&gt;</dl>
<dl><dt><strong>DXF</strong> = &lt;ValidFileTypes.DXF: 'dxf'&gt;</dl>
<dl><dt><strong>OBJ</strong> = &lt;ValidFileTypes.OBJ: 'obj'&gt;</dl>
<dl><dt><strong>STEP</strong> = &lt;ValidFileTypes.STEP: 'step'&gt;</dl>
<dl><dt><strong>STL</strong> = &lt;ValidFileTypes.STL: 'stl'&gt;</dl>
<hr>
Data descriptors inherited from <a href="enum.html#Enum">enum.Enum</a>:<br>
<dl><dt><strong>name</strong></dt>
<dd><tt>The&nbsp;name&nbsp;of&nbsp;the&nbsp;Enum&nbsp;member.</tt></dd>
</dl>
<dl><dt><strong>value</strong></dt>
<dd><tt>The&nbsp;value&nbsp;of&nbsp;the&nbsp;Enum&nbsp;member.</tt></dd>
</dl>
<hr>
Readonly properties inherited from <a href="enum.html#EnumMeta">enum.EnumMeta</a>:<br>
<dl><dt><strong>__members__</strong></dt>
<dd><tt>Returns&nbsp;a&nbsp;mapping&nbsp;of&nbsp;member&nbsp;name-&gt;value.<br>
&nbsp;<br>
This&nbsp;mapping&nbsp;lists&nbsp;all&nbsp;enum&nbsp;members,&nbsp;including&nbsp;aliases.&nbsp;Note&nbsp;that&nbsp;this<br>
is&nbsp;a&nbsp;read-only&nbsp;view&nbsp;of&nbsp;the&nbsp;internal&nbsp;mapping.</tt></dd>
</dl>
</td></tr></table></td></tr></table>
</body></html>

161
docs/html/kittycad.types.html
View File

@ -1,161 +0,0 @@
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module kittycad.types</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="kittycad.html"><font color="#ffffff">kittycad</font></a>.types</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/runner/work/kittycad.py/kittycad.py/kittycad/types.py">/home/runner/work/kittycad.py/kittycad.py/kittycad/types.py</a></font></td></tr></table>
<p><tt>Contains&nbsp;some&nbsp;shared&nbsp;types&nbsp;for&nbsp;properties</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="attr.html">attr</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="builtins.html#object">builtins.object</a>
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.types.html#File">File</a>
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="typing.html#Generic">typing.Generic</a>(<a href="builtins.html#object">builtins.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="kittycad.types.html#Response">Response</a>
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="File">class <strong>File</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#File">File</a>(payload:&nbsp;Union[BinaryIO,&nbsp;TextIO],&nbsp;file_name:&nbsp;Optional[str]&nbsp;=&nbsp;None,&nbsp;mime_type:&nbsp;Optional[str]&nbsp;=&nbsp;None)&nbsp;-&amp;gt;&nbsp;None<br>
&nbsp;<br>
Contains&nbsp;information&nbsp;for&nbsp;file&nbsp;uploads<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="File-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#File">File</a>.</tt></dd></dl>
<dl><dt><a name="File-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#File">File</a>.</tt></dd></dl>
<dl><dt><a name="File-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#File">File</a>.</tt></dd></dl>
<dl><dt><a name="File-__init__"><strong>__init__</strong></a>(self, payload: Union[BinaryIO, TextIO], file_name: Optional[str] = None, mime_type: Optional[str] = None) -&gt; None</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#File">File</a>.</tt></dd></dl>
<dl><dt><a name="File-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#File">File</a>.</tt></dd></dl>
<dl><dt><a name="File-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#File">File</a>.</tt></dd></dl>
<dl><dt><a name="File-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#File">File</a>.</tt></dd></dl>
<dl><dt><a name="File-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#File">File</a>.</tt></dd></dl>
<dl><dt><a name="File-to_tuple"><strong>to_tuple</strong></a>(self) -&gt; Tuple[Optional[str], Union[BinaryIO, TextIO], Optional[str]]</dt><dd><tt>Return&nbsp;a&nbsp;tuple&nbsp;representation&nbsp;that&nbsp;httpx&nbsp;will&nbsp;accept&nbsp;for&nbsp;multipart/form-data</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__annotations__</strong> = {'file_name': typing.Optional[str], 'mime_type': typing.Optional[str], 'payload': typing.Union[typing.BinaryIO, typing.TextIO]}</dl>
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='payload', default=NOTHING, vali...kw_only=False, inherited=False, on_setattr=None))</dl>
<dl><dt><strong>__hash__</strong> = None</dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#000000" face="helvetica, arial"><a name="Response">class <strong>Response</strong></a>(<a href="typing.html#Generic">typing.Generic</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
<td colspan=2><tt><a href="#Response">Response</a>(status_code:&nbsp;int,&nbsp;content:&nbsp;bytes,&nbsp;headers:&nbsp;MutableMapping[str,&nbsp;str],&nbsp;parsed:&nbsp;Optional[~T])&nbsp;-&amp;gt;&nbsp;None<br>
&nbsp;<br>
A&nbsp;response&nbsp;from&nbsp;an&nbsp;endpoint<br>&nbsp;</tt></td></tr>
<tr><td>&nbsp;</td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="kittycad.types.html#Response">Response</a></dd>
<dd><a href="typing.html#Generic">typing.Generic</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="Response-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Response">Response</a>.</tt></dd></dl>
<dl><dt><a name="Response-__ge__"><strong>__ge__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Response">Response</a>.</tt></dd></dl>
<dl><dt><a name="Response-__gt__"><strong>__gt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Response">Response</a>.</tt></dd></dl>
<dl><dt><a name="Response-__init__"><strong>__init__</strong></a>(self, status_code: int, content: bytes, headers: MutableMapping[str, str], parsed: Optional[~T]) -&gt; None</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Response">Response</a>.</tt></dd></dl>
<dl><dt><a name="Response-__le__"><strong>__le__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Response">Response</a>.</tt></dd></dl>
<dl><dt><a name="Response-__lt__"><strong>__lt__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Response">Response</a>.</tt></dd></dl>
<dl><dt><a name="Response-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Response">Response</a>.</tt></dd></dl>
<dl><dt><a name="Response-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Method&nbsp;generated&nbsp;by&nbsp;attrs&nbsp;for&nbsp;class&nbsp;<a href="#Response">Response</a>.</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
</dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__annotations__</strong> = {'content': &lt;class 'bytes'&gt;, 'headers': typing.MutableMapping[str, str], 'parsed': typing.Optional[~T], 'status_code': &lt;class 'int'&gt;}</dl>
<dl><dt><strong>__attrs_attrs__</strong> = (Attribute(name='status_code', default=NOTHING, ...kw_only=False, inherited=False, on_setattr=None))</dl>
<dl><dt><strong>__hash__</strong> = None</dl>
<dl><dt><strong>__orig_bases__</strong> = (typing.Generic[~T],)</dl>
<dl><dt><strong>__parameters__</strong> = (~T,)</dl>
<hr>
Class methods inherited from <a href="typing.html#Generic">typing.Generic</a>:<br>
<dl><dt><a name="Response-__class_getitem__"><strong>__class_getitem__</strong></a>(params)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
<dl><dt><a name="Response-__init_subclass__"><strong>__init_subclass__</strong></a>(*args, **kwargs)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt><dd><tt>This&nbsp;method&nbsp;is&nbsp;called&nbsp;when&nbsp;a&nbsp;class&nbsp;is&nbsp;subclassed.<br>
&nbsp;<br>
The&nbsp;default&nbsp;implementation&nbsp;does&nbsp;nothing.&nbsp;It&nbsp;may&nbsp;be<br>
overridden&nbsp;to&nbsp;extend&nbsp;subclasses.</tt></dd></dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom>&nbsp;<br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
<td width="100%"><strong>FileJsonType</strong> = typing.Tuple[typing.Optional[str], typing.Union[...g.BinaryIO, typing.TextIO], typing.Optional[str]]<br>
<strong>__all__</strong> = ['File', 'Response', 'FileJsonType']<br>
<strong>__annotations__</strong> = {'UNSET': &lt;class 'kittycad.types.Unset'&gt;}</td></tr></table>
</body></html>

BIN
docs/html/objects.inv Normal file
View File

Binary file not shown.

119
docs/html/search.html Normal file
View File

@ -0,0 +1,119 @@
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &#8212; kittycad v0.0.3 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css" />
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<script src="_static/searchtools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="#" />
<script src="searchindex.js" defer></script>
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1 id="search-documentation">Search</h1>
<noscript>
<div class="admonition warning">
<p>
Please activate JavaScript to enable the search
functionality.
</p>
</div>
</noscript>
<p>
Searching for multiple words only shows matches that contain
all words.
</p>
<form action="" method="get">
<input type="text" name="q" aria-labelledby="search-documentation" value="" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="search" />
<span id="search-progress" style="padding-left: 10px"></span>
</form>
<div id="search-results">
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="index.html">kittycad</a></h1>
<h3>Navigation</h3>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="index.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2021, KittyCAD Inc..
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 4.3.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
</div>
</body>
</html>

1
docs/html/searchindex.js Normal file
View File

@ -0,0 +1 @@
Search.setIndex({docnames:["index"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.intersphinx":1,sphinx:56},filenames:["index.rst"],objects:{},objnames:{},objtypes:{},terms:{index:0,modul:0,page:0,search:0},titles:["Welcome to kittycad\u2019s documentation!"],titleterms:{document:0,indic:0,kittycad:0,s:0,tabl:0,welcom:0}})

20
docs/index.rst Normal file
View File

@ -0,0 +1,20 @@
.. kittycad documentation master file, created by
sphinx-quickstart on Wed Dec 15 10:15:30 2021.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to kittycad's documentation!
====================================
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

35
docs/make.bat Normal file
View File

@ -0,0 +1,35 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=.
set BUILDDIR=_build
if "%1" == "" goto help
%SPHINXBUILD% >NUL 2>NUL
if errorlevel 9009 (
echo.
echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
echo.installed, then set the SPHINXBUILD environment variable to point
echo.to the full path of the 'sphinx-build' executable. Alternatively you
echo.may add the Sphinx directory to PATH.
echo.
echo.If you don't have Sphinx installed, grab it from
echo.https://www.sphinx-doc.org/
exit /b 1
)
%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
goto end
:help
%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
:end
popd

9
pyproject.toml
View File

@ -17,6 +17,15 @@ httpx = ">=0.15.4,<0.21.0"
attrs = ">=20.1.0,<22.0.0"
python-dateutil = "^2.8.0"
[tool.poetry.dev-dependencies]
Sphinx = "^4.3.1"
flake8 = "^4.0.1"
pytest = "^6.2.5"
sphinx-autodoc-typehints = "^1.12.0"
pyenchant = "^3.2.2"
sphinxcontrib-spelling = "^7.3.0"
toml = "^0.10.2"
[build-system]
requires = ["poetry>=1.0"]
build-backend = "poetry.masonry.api"