Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 8 additions & 11 deletions .github/workflows/check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,24 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-python@v5
with:
python-version: 3.9
fetch-depth: 0

- name: Install Poetry Action
uses: snok/install-poetry@v1.3.4
- uses: actions/setup-python@v5
with:
version: 1.7.0
python-version: "3.9"

- name: Installing dependencies...
run: poetry install --no-interaction --with dev,test
- name: Install Hatch
uses: pypa/hatch@install

- name: Formatting check
if: always()
run: poetry run black --check .
run: hatch run dev:black --check .

- name: Linting
if: always()
run: poetry run ruff .
run: hatch run dev:ruff check .

- name: Type checking
if: always()
run: poetry run mypy .
run: hatch run dev:mypy .
46 changes: 31 additions & 15 deletions .github/workflows/docs-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,14 @@ name: Publish documentation

on:
push:
# Trigger on all branches and all tags
branches:
- main
- "**"
tags:
- "*"
- "**"
pull_request:
branches:
- main

permissions:
contents: write
Expand All @@ -14,30 +18,42 @@ jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v6
with:
fetch-depth: 0

- name: Configure Git Credentials
run: |
git config user.name github-actions[bot]
git config user.email 41898282+github-actions[bot]@users.noreply.github.com

- uses: actions/setup-python@v5
- uses: actions/setup-python@v6
with:
python-version: 3.9
python-version: "3.9"

- name: Install Poetry Action
uses: snok/install-poetry@v1.3.4
with:
version: 1.7.0
- name: Install Hatch
uses: pypa/hatch@install

- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV

- uses: actions/cache@v4
- uses: actions/cache@v5
with:
key: mkdocs-material-${{ env.cache_id }}
key: zensical-${{ env.cache_id }}
path: .cache
restore-keys: |
mkdocs-material-

- run: poetry install --no-interaction --with docs
- run: poetry run mkdocs gh-deploy --force
zensical-

# Test build docs on PRs
- name: Verify Docs Build (on Pull Requests)
if: github.event_name == 'pull_request'
run: hatch run docs:build

# Deploy dev documentation
- name: Deploy Branch Documentation
if: github.event_name == 'push' && !startsWith(github.ref, 'refs/tags/')
run: hatch run docs:deploy ${{ github.ref_name }}

# Deploy release documentation
- name: Deploy Release Documentation
if: startsWith(github.ref, 'refs/tags/')
run: hatch run docs:deploy ${{ github.ref_name }} latest
18 changes: 12 additions & 6 deletions .github/workflows/pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,21 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0

- uses: actions/setup-python@v5
with:
python-version: 3.9
python-version: "3.9"

- name: Install Poetry Action
uses: snok/install-poetry@v1.3.4
with:
version: 1.7.0
- name: Install Hatch
uses: pypa/hatch@install

- name: Build package
run: hatch build

- name: Publish to PyPi
run: poetry publish --build --username __token__ --password ${{ secrets.PYPI_TOKEN }}
env:
HATCH_INDEX_USER: __token__
HATCH_INDEX_AUTH: ${{ secrets.PYPI_TOKEN }}
run: hatch publish
7 changes: 5 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ ENV/
env.bak/
venv.bak/

# mkdocs documentation
# zensical documentation
/site

# mypy
Expand All @@ -61,4 +61,7 @@ venv.bak/

.idea/
.pytest_cache/
.vscode
.vscode

# hatch version
pytvpaint/_version.py
3 changes: 3 additions & 0 deletions docs/api/george/guideline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Guideline related George functions

::: pytvpaint.george.grg_guideline
3 changes: 3 additions & 0 deletions docs/api/objects/guideline.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Guideline class

::: pytvpaint.guideline.Guideline
3 changes: 3 additions & 0 deletions docs/api/objects/guideline_animatorfield.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GuidelineAnimatorField class

::: pytvpaint.guideline.GuidelineAnimatorField
3 changes: 3 additions & 0 deletions docs/api/objects/guideline_circle.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GuidelineCircle class

::: pytvpaint.guideline.GuidelineCircle
3 changes: 3 additions & 0 deletions docs/api/objects/guideline_ellipse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GuidelineEllipse class

::: pytvpaint.guideline.GuidelineEllipse
3 changes: 3 additions & 0 deletions docs/api/objects/guideline_fieldchart.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GuidelineFieldChart class

::: pytvpaint.guideline.GuidelineFieldChart
3 changes: 3 additions & 0 deletions docs/api/objects/guideline_grid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GuidelineGrid class

::: pytvpaint.guideline.GuidelineGrid
3 changes: 3 additions & 0 deletions docs/api/objects/guideline_image.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GuidelineImage class

::: pytvpaint.guideline.GuidelineImage
3 changes: 3 additions & 0 deletions docs/api/objects/guideline_line.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GuidelineImage class

::: pytvpaint.guideline.GuidelineLine
3 changes: 3 additions & 0 deletions docs/api/objects/guideline_marks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GuidelineMarks class

::: pytvpaint.guideline.GuidelineMarks
3 changes: 3 additions & 0 deletions docs/api/objects/guideline_safearea.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GuidelineSafeArea class

::: pytvpaint.guideline.GuidelineSafeArea
3 changes: 3 additions & 0 deletions docs/api/objects/guideline_segment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GuidelineSegment class

::: pytvpaint.guideline.GuidelineSegment
3 changes: 3 additions & 0 deletions docs/api/objects/guideline_vanishpoint1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GuidelineVanishPoint1 class

::: pytvpaint.guideline.GuidelineVanishPoint1
3 changes: 3 additions & 0 deletions docs/api/objects/guideline_vanishpoint2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GuidelineVanishPoint2 class

::: pytvpaint.guideline.GuidelineVanishPoint2
3 changes: 3 additions & 0 deletions docs/api/objects/guideline_vanishpoint3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# GuidelineVanishPoint3 class

::: pytvpaint.guideline.GuidelineVanishPoint3
2 changes: 1 addition & 1 deletion docs/api/objects/layer.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Layer class

::: pytvpaint.layer.Layer
::: pytvpaint.layer.Layer
3 changes: 3 additions & 0 deletions docs/api/objects/layer_camera.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Camera Layer class

::: pytvpaint.layer.CameraLayer
3 changes: 3 additions & 0 deletions docs/api/objects/layer_ctg.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# CTG Layer class

::: pytvpaint.layer.CTGLayer
3 changes: 3 additions & 0 deletions docs/api/objects/layer_folder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Layer Folder class

::: pytvpaint.layer.LayerFolder
Loading
Loading