Compare commits

...

124 Commits

Author SHA1 Message Date
d9077a00ad bump the version;
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-04-06 21:15:39 -07:00
a8d537e29c update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-04-06 21:14:32 -07:00
15d5bf50c1 update files
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-04-06 21:14:12 -07:00
17b517dd5a update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-04-06 20:50:09 -07:00
1408f075ee more fixes
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-04-06 20:50:09 -07:00
ed6b2c8e77 I HAVE GENERATED YOUR NEW DOCS! 2022-04-07 03:38:23 +00:00
69c4f8ce70 format
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-04-06 20:37:08 -07:00
216b454c14 add more
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-04-06 20:35:34 -07:00
0ed9aaf127 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-04-06 20:35:21 -07:00
c1bc2a8f51 Merge pull request #11 from KittyCAD/update-spec-v0.0.9
Update go lang spec docs for v0.0.9
2022-04-06 19:13:29 -07:00
b7359511a4 YOYO NEW GO SPEC DOCS v0.0.9! 2022-04-07 02:12:48 +00:00
26545d537f Merge pull request #10 from KittyCAD/dependabot/github_actions/codecov/codecov-action-3
Bump codecov/codecov-action from 2 to 3
2022-04-06 18:34:57 -07:00
0ab0bd44a2 Bump codecov/codecov-action from 2 to 3
Bumps [codecov/codecov-action](https://github.com/codecov/codecov-action) from 2 to 3.
- [Release notes](https://github.com/codecov/codecov-action/releases)
- [Changelog](https://github.com/codecov/codecov-action/blob/master/CHANGELOG.md)
- [Commits](https://github.com/codecov/codecov-action/compare/v2...v3)

---
updated-dependencies:
- dependency-name: codecov/codecov-action
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-04-06 11:24:42 +00:00
415f1d9619 I HAVE GENERATED YOUR NEW DOCS! 2022-04-04 19:42:53 +00:00
31f5188454 fix example
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-04-04 12:40:15 -07:00
363e9aea12 bump version
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-04-04 10:16:16 -07:00
ca263dd395 Merge pull request #9 from KittyCAD/update-spec-v0.0.8
Update go lang spec docs for v0.0.8
2022-04-04 10:14:34 -07:00
1e2e9c0871 fix
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-04-04 10:10:19 -07:00
6db080ebc8 YOYO NEW GO SPEC DOCS v0.0.8! 2022-04-04 09:43:09 -07:00
5247831f32 fix
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-04-04 09:42:54 -07:00
5e204bf872 I HAVE GENERATED YOUR NEW DOCS! 2022-04-04 16:32:51 +00:00
9cbcebf665 Merge pull request #8 from KittyCAD/dependabot/github_actions/actions/checkout-3
Bump actions/checkout from 2 to 3
2022-04-04 09:30:03 -07:00
fdc005a2f7 I HAVE GENERATED YOUR NEW DOCS! 2022-03-07 01:53:16 +00:00
004daabdf9 update client and fixes
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-03-06 17:50:08 -08:00
a14fa0b099 Bump actions/checkout from 2 to 3
Bumps [actions/checkout](https://github.com/actions/checkout) from 2 to 3.
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](https://github.com/actions/checkout/compare/v2...v3)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-03-07 01:35:13 +00:00
020b19a3c2 I HAVE GENERATED YOUR NEW DOCS! 2022-03-07 01:22:58 +00:00
d2ea7ddf66 Merge pull request #3 from KittyCAD/dependabot/pip/pytest-tw-7.0.1
Update pytest requirement from ^6.2.5 to ^7.0.1
2022-03-06 17:22:04 -08:00
6210725498 Merge pull request #7 from KittyCAD/dependabot/github_actions/actions/setup-python-3
Bump actions/setup-python from 2 to 3
2022-03-06 17:20:30 -08:00
3531fd4197 Update pytest requirement from ^6.2.5 to ^7.0.1
Updates the requirements on [pytest](https://github.com/pytest-dev/pytest) to permit the latest version.
- [Release notes](https://github.com/pytest-dev/pytest/releases)
- [Changelog](https://github.com/pytest-dev/pytest/blob/main/CHANGELOG.rst)
- [Commits](https://github.com/pytest-dev/pytest/compare/6.2.5...7.0.1)

---
updated-dependencies:
- dependency-name: pytest
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-03-07 01:19:04 +00:00
1c94c0500c I HAVE GENERATED YOUR NEW DOCS! 2022-03-07 01:17:39 +00:00
eae6825815 Bump actions/setup-python from 2 to 3
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 2 to 3.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v2...v3)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2022-03-07 01:17:04 +00:00
a11d9e9351 Merge pull request #4 from KittyCAD/refactor
Refactor
2022-03-06 17:15:06 -08:00
5d985a3e13 fix
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-28 12:53:39 -08:00
6b6de6ddf2 fix
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-28 12:30:27 -08:00
aa723677a3 fix
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 22:56:08 -08:00
3477374e44 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 22:55:08 -08:00
f28d56915a update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 22:45:11 -08:00
cf3ab0f291 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 22:41:34 -08:00
e53597609c ad docs
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 22:38:36 -08:00
3d8c49afe3 cleabup
;

Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 22:36:12 -08:00
669b7aded0 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 22:30:43 -08:00
0ceebbee9c fix tests
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 22:25:36 -08:00
ab01c82bb7 make tests pass
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 22:24:39 -08:00
65e95eae3d better json
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 22:19:21 -08:00
5fcd6d048e update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 22:10:46 -08:00
89a450f697 write the data back out.
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 21:59:28 -08:00
653d2b21ee pep8
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 21:48:39 -08:00
cbf5f4df6d update functions;
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 21:48:13 -08:00
2d90bb61be better tabs
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 21:36:28 -08:00
9c18ba2350 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 21:34:21 -08:00
0b9c32e6bf better indent
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 21:23:35 -08:00
b09684bd9e better indent
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 21:16:28 -08:00
45ac31914d update paths
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 21:13:56 -08:00
2a9ae9dc8d fix ups and autopep8
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 20:15:59 -08:00
5b77fbdbd0 add autopep8
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 20:14:39 -08:00
e0f88cf27a pep8
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 20:12:59 -08:00
29b0d3b5d0 update build
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 20:10:11 -08:00
6c05eabb2c update the __init__.py
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 20:06:23 -08:00
be59e657b9 raise exception
;

Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 20:02:13 -08:00
bf83d1f1ba raise errrors
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 20:00:17 -08:00
a99251b3b7 add more types
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 19:58:57 -08:00
32479cfe2a add types
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 19:58:46 -08:00
2a3cec9aac start of refactor
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-02-27 18:39:04 -08:00
e7aaaab78d biump
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-01-28 15:06:33 -08:00
f835e905a9 I HAVE GENERATED YOUR NEW DOCS! 2022-01-28 22:35:46 +00:00
637df816fd update supported formats
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2022-01-28 14:34:06 -08:00
cef71917e8 Create LICENSE 2021-12-20 10:54:55 -08:00
c865f88379 Update dependabot.yml 2021-12-17 02:18:28 -08:00
7dbafade7a I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 23:48:37 +00:00
3f9366e0c9 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 15:47:11 -08:00
f69db1296b bump version
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 15:16:27 -08:00
587ba78ada I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 18:15:57 +00:00
41127aa9d3 add in more tests
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 10:14:25 -08:00
4bb7008d5d I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 15:00:34 +00:00
d8a9721d18 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:59:04 -08:00
5d237a4eda I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 14:58:26 +00:00
30999f1cd3 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:57:05 -08:00
fc6ea7af77 I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 14:51:14 +00:00
0d0afa4497 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:49:55 -08:00
a4d57836f5 I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 14:45:22 +00:00
e9c5722b1d update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:43:50 -08:00
803c016174 I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 14:37:04 +00:00
2a5c28f9a9 fix
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:35:32 -08:00
5afd7562d4 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:32:40 -08:00
afcc5b88c1 run pytest
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:32:40 -08:00
bd072b07a3 update for pytest
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:32:39 -08:00
324e803f0e I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 14:27:54 +00:00
a757aaa633 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:26:21 -08:00
37b2635a01 I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 14:23:17 +00:00
ab06822559 fix
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:23:12 -08:00
9678dabcb6 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:21:45 -08:00
5a024a1949 fixc
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:21:11 -08:00
00a7f93a94 add docs
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:19:51 -08:00
9d3cf53570 I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 14:17:23 +00:00
ccc30676ef cleanup
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:16:02 -08:00
5c01da0271 add the file
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:15:03 -08:00
a4cf10655f update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:15:03 -08:00
900d90fdb4 I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 14:12:56 +00:00
2ca2b5f87b update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:11:05 -08:00
12c5b1ba49 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 06:02:09 -08:00
134c904d90 I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 11:56:44 +00:00
059dc0e521 update docs
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 03:54:54 -08:00
dfa76e9462 updates
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 03:54:54 -08:00
abf4ce8e52 clean the folder first
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 03:54:54 -08:00
2761fc47f6 Update README.md 2021-12-15 02:08:42 -08:00
f3d080d971 I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 10:04:26 +00:00
00b5cd9288 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 02:03:32 -08:00
5954a57a5d update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 02:00:30 -08:00
d40e7832a2 I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 09:58:14 +00:00
eb33fd8c9c update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 01:57:39 -08:00
5e7fe2f663 fix
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 01:57:39 -08:00
a4a74c780a I HAVE GENERATED YOUR NEW DOCS! 2021-12-15 09:55:26 +00:00
2235d10966 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 01:54:47 -08:00
cba4690d88 install
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 01:53:07 -08:00
ce8338cc3e update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 01:51:26 -08:00
800ce9ccdf try again
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 01:29:24 -08:00
2895434602 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 01:27:44 -08:00
c3cd16858a update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 01:25:48 -08:00
b0c71ad0f5 cleanup
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 01:24:18 -08:00
7c964a3d05 generate the docs
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 01:23:59 -08:00
10b2aa4f2a add content
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 01:18:36 -08:00
ae1353ef82 Create dependabot.yml 2021-12-15 01:09:43 -08:00
613864cf42 update
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 01:06:41 -08:00
3ee3ae9a6c move around files
Signed-off-by: Jess Frazelle <github@jessfraz.com>
2021-12-15 01:05:44 -08:00
257 changed files with 32776 additions and 902 deletions

15
.github/dependabot.yml vendored Normal file
View File

@ -0,0 +1,15 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
version: 2
updates:
- package-ecosystem: "pip" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "daily"
- package-ecosystem: "github-actions" # See documentation for possible values
directory: "/" # Location of package manifests
schedule:
interval: "daily"

View File

@ -5,22 +5,26 @@ on:
paths:
- '**.py'
- .github/workflows/build-test.yml
- 'pyproject.toml'
- 'spec.json'
pull_request:
paths:
- '**.py'
- .github/workflows/build-test.yml
- 'pyproject.toml'
- 'spec.json'
jobs:
build-test:
runs-on: ubuntu-latest
strategy:
matrix:
python-version: [3.6, 3.7, 3.8, 3.9]
python-version: [3.7, 3.8, 3.9]
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
uses: actions/setup-python@v3
with:
python-version: ${{ matrix.python-version }}
@ -29,21 +33,35 @@ jobs:
shell: bash
run: |
pip install \
flake8 \
poetry \
pytest
poetry
- name: Build
shell: bash
run: |
cd kittycad
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
- name: Run pytest
shell: bash
run: |
poetry run pytest --cov=./ --cov-report=xml kittycad
env:
KITTYCAD_API_TOKEN: ${{secrets.KITTYCAD_API_TOKEN}}
- name: Upload coverage to Codecov
uses: codecov/codecov-action@v3
with:
token: ${{ secrets.CODECOV_TOKEN }}
fail_ci_if_error: true
flags: unittests
files: ${{ github.workspace }}/coverage.xml
verbose: true

62
.github/workflows/generate-docs.yml vendored Normal file
View File

@ -0,0 +1,62 @@
name: generate docs
permissions:
contents: write
on:
push:
branches: main
paths:
- docs/conf.py
- '**.rst'
- '**.py'
- .github/workflows/generate-docs.yml
jobs:
generate-docs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v3
with:
python-version: 3.x
# Installation instructions are from: https://python-poetry.org/docs/
- name: Install dependencies
shell: bash
run: |
sudo apt update && sudo apt install -y \
enchant-2 \
--no-install-recommends
pip install \
poetry
- name: Build
shell: bash
run: |
poetry build
- name: Generate the docs
shell: bash
run: |
rm -rf docs/html
poetry install
poetry run sphinx-build -b html docs/ docs/html/
- name: Check for modified files
id: git-check
run: echo ::set-output name=modified::$(if git diff-index --ignore-submodules --quiet HEAD --; then echo "false"; else echo "true"; fi)
- name: Commit changes, if any
if: steps.git-check.outputs.modified == 'true'
run: |
git add .
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git remote set-url origin https://${{ github.actor }}:${{ secrets.GITHUB_TOKEN }}@github.com/${{ github.repository }}.git
git commit -am "I HAVE GENERATED YOUR NEW DOCS!" || true
git fetch origin
git rebase origin/${{github.ref_name }} || true
git push origin ${{github.ref_name }}

View File

@ -6,6 +6,7 @@ on:
paths:
- 'Makefile'
- .github/workflows/generate.yml
- 'spec.json'
workflow_dispatch:
inputs:
jobs:
@ -14,7 +15,7 @@ jobs:
if: ${{ github.event.pull_request.head.repo.full_name == github.repository }}
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
ref: ${{ github.event.pull_request.head.ref }}
- name: Run generate

View File

@ -8,8 +8,8 @@ jobs:
name: make-release
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/setup-python@v2
- uses: actions/checkout@v3
- uses: actions/setup-python@v3
with:
python-version: '3.x'
# Installation instructions are from: https://python-poetry.org/docs/
@ -21,7 +21,6 @@ jobs:
- name: Do the release
shell: bash
run: |
cd kittycad
poetry publish --build \
--username ${{secrets.PYPI_USERNAME}} \
--password ${{secrets.PYPI_SECRET}}

View File

@ -0,0 +1,69 @@
on:
push:
tags:
- v*
pull_request:
paths:
- .github/workflows/update-spec-for-docs.yml
workflow_dispatch:
name: update spec for docs
concurrency:
group: docs-${{ github.ref }}
cancel-in-progress: true
jobs:
update-spec:
name: update-spec
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/setup-go@v2
with:
go-version: '1.x'
- name: make generate
shell: bash
run: |
make generate
# Ensure no files changed.
- name: Ensure no files changed
shell: bash
run: |
if [[ `git status --porcelain` ]]; then
echo "Files changed, exiting";
exit 1;
else
# No changes
echo "No files changed, proceeding";
fi
# Checkout the docs repo since we will want to update the files there.
- uses: actions/checkout@v3
with:
repository: 'kittycad/docs'
path: 'docs'
token: ${{secrets.PAT_GITHUB}}
- name: move spec to docs
shell: bash
run: |
rm docs/spec.json || true
cp spec.json docs/spec.json
- name: commit the changes in the docs repo
shell: bash
run: |
export VERSION=$(cat VERSION.txt);
cd docs
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git add .
git commit -am "YOYO NEW SPEC DOCS ${VERSION}!" || exit 0
git fetch origin
git rebase origin/main || exit 0
export NEW_BRANCH="update-spec-${VERSION}"
git checkout -b "$NEW_BRANCH"
git push -f origin "$NEW_BRANCH"
gh pr create --title "Update lang spec docs for ${VERSION}" \
--body "Updating the generated docs for go lang" \
--head "$NEW_BRANCH" \
--base main || true
env:
GITHUB_TOKEN: ${{secrets.PAT_GITHUB}}

View File

@ -20,4 +20,6 @@ dmypy.json
.idea/
/coverage.xml
/.coverage
/.coverage
poetry.lock

View File

@ -1,7 +1,13 @@
FROM python:latest
FROM python:3.9
RUN pip install \
openapi-python-client
poetry
WORKDIR /usr/src/
COPY . /usr/src/
RUN poetry update && poetry install
# Set the default command to bash.
CMD ["bash"]

21
LICENSE Normal file
View File

@ -0,0 +1,21 @@
MIT License
Copyright (c) 2021 KittyCAD
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

View File

@ -7,17 +7,24 @@ endif
# For this to work, you need to install toml-cli: https://github.com/gnprice/toml-cli
# `cargo install toml-cli`
VERSION := $(shell toml get $(CURDIR)/kittycad/pyproject.toml tool.poetry.version | jq -r .)
VERSION := $(shell toml get $(CURDIR)/pyproject.toml tool.poetry.version | jq -r .)
.PHONY: generate
generate: docker-image
generate: docker-image ## Generate the api client.
docker run --rm -i $(DOCKER_FLAGS) \
--name python-generator \
-v $(CURDIR):/usr/src \
--workdir /usr/src \
$(DOCKER_IMAGE_NAME) openapi-python-client update \
--url https://api.kittycad.io \
--config /usr/src/config.yml
$(DOCKER_IMAGE_NAME) sh -c 'poetry run python generate/generate.py && poetry run autopep8 --in-place --aggressive --aggressive kittycad/models/*.py && poetry run autopep8 --in-place --aggressive --aggressive kittycad/api/*.py && poetry run autopep8 --in-place --aggressive --aggressive kittycad/*.py && poetry run autopep8 --in-place --aggressive --aggressive generate/*.py'
.PHONY: shell
shell: docker-image ## Pop into a shell in the docker image.
docker run --rm -i $(DOCKER_FLAGS) \
--name python-generator-shell \
-v $(CURDIR):/usr/src \
--workdir /usr/src \
$(DOCKER_IMAGE_NAME) /bin/bash
.PHONY: docker-image
docker-image:

View File

@ -2,10 +2,8 @@
The Python API client for KittyCAD.
This is generated from
[openapi-generators/openapi-python-client](https://github.com/openapi-generators/openapi-python-client).
- [PyPI](https://pypi.org/project/kittycad/)
- [Python docs](https://python.api.docs.kittycad.io/)
- [KittyCAD API Docs](https://docs.kittycad.io/?lang=python)
## Generating

BIN
assets/testing.stl Normal file

Binary file not shown.

View File

@ -1,2 +0,0 @@
project_name_override: kittycad
package_name_override: kittycad

View File

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

View File

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

113
docs/conf.py Normal file
View File

@ -0,0 +1,113 @@
# 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.insert(1, os.path.dirname(os.path.abspath(__file__)))
sys.path.append(os.path.abspath('../kittycad'))
# -- Project information -----------------------------------------------------
project = 'kittycad'
author = 'KittyCAD Team Members'
copyright = author
# 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']
version = 'v'+version
release = 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',
'sphinx_automodapi.automodapi',
'sphinx_rtd_theme'
]
numpydoc_show_class_members = False
automodapi_inheritance_diagram = False
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# 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 = 'sphinx_rtd_theme'
# Add any paths that contain custom themes here, relative to this directory.
html_theme_path = [
]
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = []
# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'trac'
# Intersphinx configuration.
# FROM: https://www.sphinx-doc.org/en/master/usage/extensions/intersphinx.html#module-sphinx.ext.intersphinx
intersphinx_mapping = {
'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: 16fc25f14c46711649e711cda6e9c6fb
tags: 645f666f9bcd5a90fca523b33c5a78b7

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

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

View File

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

View File

@ -0,0 +1,26 @@
.. 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!
====================================
.. autosummary::
:recursive:
:toctree: modules
kittycad.api
kittycad.client
kittycad.models
kittycad.types
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. automodapi:: kittycad

View File

@ -0,0 +1,23 @@
kittycad.api.beta
=================
.. automodule:: kittycad.api.beta

View File

@ -0,0 +1,32 @@
kittycad.api.file.file\_conversion\_status
==========================================
.. automodule:: kittycad.api.file.file_conversion_status
.. rubric:: Functions
.. autosummary::
asyncio
asyncio_detailed
sync
sync_detailed

View File

@ -0,0 +1,30 @@
kittycad.api.file.file\_conversion\_status\_with\_base64\_helper
================================================================
.. automodule:: kittycad.api.file.file_conversion_status_with_base64_helper
.. rubric:: Functions
.. autosummary::
asyncio
sync

View File

@ -0,0 +1,32 @@
kittycad.api.file.post\_file\_conversion
========================================
.. automodule:: kittycad.api.file.post_file_conversion
.. rubric:: Functions
.. autosummary::
asyncio
asyncio_detailed
sync
sync_detailed

View File

@ -0,0 +1,30 @@
kittycad.api.file.post\_file\_conversion\_with\_base64\_helper
==============================================================
.. automodule:: kittycad.api.file.post_file_conversion_with_base64_helper
.. rubric:: Functions
.. autosummary::
asyncio
sync

View File

@ -0,0 +1,39 @@
kittycad.api.file
=================
.. automodule:: kittycad.api.file
.. rubric:: Modules
.. autosummary::
:toctree:
:recursive:
kittycad.api.file.create_file_conversion
kittycad.api.file.file_conversion_status
kittycad.api.file.file_conversion_status_with_base64_helper
kittycad.api.file.get_file_conversion
kittycad.api.file.get_file_conversion_for_user
kittycad.api.file.list_file_conversions
kittycad.api.file.list_file_conversions_for_user
kittycad.api.file.post_file_conversion
kittycad.api.file.post_file_conversion_with_base64_helper

View File

@ -0,0 +1,32 @@
kittycad.api.internal.gpu\_devices
==================================
.. automodule:: kittycad.api.internal.gpu_devices
.. rubric:: Functions
.. autosummary::
asyncio
asyncio_detailed
sync
sync_detailed

View File

@ -0,0 +1,32 @@
kittycad.api.internal
=====================
.. automodule:: kittycad.api.internal
.. rubric:: Modules
.. autosummary::
:toctree:
:recursive:
kittycad.api.internal.gpu_devices
kittycad.api.internal.stop_async_conversions

View File

@ -0,0 +1,32 @@
kittycad.api.internal.stop\_async\_conversions
==============================================
.. automodule:: kittycad.api.internal.stop_async_conversions
.. rubric:: Functions
.. autosummary::
asyncio
asyncio_detailed
sync
sync_detailed

View File

@ -0,0 +1,32 @@
kittycad.api.meta.auth\_session
===============================
.. automodule:: kittycad.api.meta.auth_session
.. rubric:: Functions
.. autosummary::
asyncio
asyncio_detailed
sync
sync_detailed

View File

@ -0,0 +1,32 @@
kittycad.api.meta.instance\_metadata
====================================
.. automodule:: kittycad.api.meta.instance_metadata
.. rubric:: Functions
.. autosummary::
asyncio
asyncio_detailed
sync
sync_detailed

View File

@ -0,0 +1,32 @@
kittycad.api.meta.ping
======================
.. automodule:: kittycad.api.meta.ping
.. rubric:: Functions
.. autosummary::
asyncio
asyncio_detailed
sync
sync_detailed

View File

@ -0,0 +1,34 @@
kittycad.api.meta
=================
.. automodule:: kittycad.api.meta
.. rubric:: Modules
.. autosummary::
:toctree:
:recursive:
kittycad.api.meta.auth_session
kittycad.api.meta.get_schema
kittycad.api.meta.instance_metadata
kittycad.api.meta.ping

View File

@ -0,0 +1,37 @@
kittycad.api
============
.. automodule:: kittycad.api
.. rubric:: Modules
.. autosummary::
:toctree:
:recursive:
kittycad.api.api-calls
kittycad.api.api-tokens
kittycad.api.beta
kittycad.api.file
kittycad.api.internal
kittycad.api.meta
kittycad.api.users

View File

@ -0,0 +1,36 @@
kittycad.api.users
==================
.. automodule:: kittycad.api.users
.. rubric:: Modules
.. autosummary::
:toctree:
:recursive:
kittycad.api.users.get_user
kittycad.api.users.get_user_extended
kittycad.api.users.get_user_self
kittycad.api.users.get_user_self_extended
kittycad.api.users.list_users
kittycad.api.users.list_users_extended

View File

@ -0,0 +1,30 @@
kittycad.client
===============
.. automodule:: kittycad.client
.. rubric:: Classes
.. autosummary::
Client
ClientFromEnv

View File

@ -0,0 +1,29 @@
kittycad.models.auth\_session
=============================
.. automodule:: kittycad.models.auth_session
.. rubric:: Classes
.. autosummary::
AuthSession

View File

@ -0,0 +1,29 @@
kittycad.models.error\_message
==============================
.. automodule:: kittycad.models.error_message
.. rubric:: Classes
.. autosummary::
ErrorMessage

View File

@ -0,0 +1,29 @@
kittycad.models.file\_conversion
================================
.. automodule:: kittycad.models.file_conversion
.. rubric:: Classes
.. autosummary::
FileConversion

View File

@ -0,0 +1,29 @@
kittycad.models.file\_conversion\_status
========================================
.. automodule:: kittycad.models.file_conversion_status
.. rubric:: Classes
.. autosummary::
FileConversionStatus

View File

@ -0,0 +1,29 @@
kittycad.models.gpu\_device
===========================
.. automodule:: kittycad.models.gpu_device
.. rubric:: Classes
.. autosummary::
GPUDevice

View File

@ -0,0 +1,29 @@
kittycad.models.instance
========================
.. automodule:: kittycad.models.instance
.. rubric:: Classes
.. autosummary::
Instance

View File

@ -0,0 +1,29 @@
kittycad.models.pong\_enum
==========================
.. automodule:: kittycad.models.pong_enum
.. rubric:: Classes
.. autosummary::
PongEnum

View File

@ -0,0 +1,29 @@
kittycad.models.pong\_message
=============================
.. automodule:: kittycad.models.pong_message
.. rubric:: Classes
.. autosummary::
PongMessage

View File

@ -0,0 +1,41 @@
kittycad.models
===============
.. automodule:: kittycad.models
.. rubric:: Modules
.. autosummary::
:toctree:
:recursive:
kittycad.models.auth_session
kittycad.models.error_message
kittycad.models.file_conversion
kittycad.models.file_conversion_status
kittycad.models.gpu_device
kittycad.models.instance
kittycad.models.pong_enum
kittycad.models.pong_message
kittycad.models.server_env
kittycad.models.valid_output_file_format
kittycad.models.valid_source_file_format

View File

@ -0,0 +1,29 @@
kittycad.models.server\_env
===========================
.. automodule:: kittycad.models.server_env
.. rubric:: Classes
.. autosummary::
ServerEnv

View File

@ -0,0 +1,29 @@
kittycad.models.valid\_output\_file\_format
===========================================
.. automodule:: kittycad.models.valid_output_file_format
.. rubric:: Classes
.. autosummary::
ValidOutputFileFormat

View File

@ -0,0 +1,29 @@
kittycad.models.valid\_source\_file\_format
===========================================
.. automodule:: kittycad.models.valid_source_file_format
.. rubric:: Classes
.. autosummary::
ValidSourceFileFormat

View File

@ -0,0 +1,31 @@
kittycad.types
==============
.. automodule:: kittycad.types
.. rubric:: Classes
.. autosummary::
File
Response
Unset

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;
}
}

View File

@ -0,0 +1 @@
.fa:before{-webkit-font-smoothing:antialiased}.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 434 KiB

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Some files were not shown because too many files have changed in this diff Show More