Skip to content
Merged
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
10 changes: 5 additions & 5 deletions .github/workflows/docs-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,16 @@ jobs:
- uses: actions/setup-python@v5
with:
python-version: "3.10.x"
- uses: abatilo/actions-poetry@v2
- name: Install dependencies
run: |
poetry install
- name: Sphinx build HTML
python -m pip install --upgrade pip
pip install -r ./docs/requirements.txt
- name: Sphinx generate API sources
run: |
poetry run sphinx-apidoc -f -e -M -o ./docs/source/ ./ayon_api/
sphinx-apidoc -f -e -M -o ./docs/source/ ./ayon_api/
- name: Sphinx build HTML
run: |
poetry run sphinx-build -M html ./docs/source ./docs/build
sphinx-build -M html ./docs/source ./docs/build

- name: Deploy to GitHub Pages
if: github.event_name == 'push'
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/python-publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install wheel
pip install build
- name: Build package
run: python setup.py sdist bdist_wheel
run: python -m build
- name: Publish package
uses: pypa/gh-action-pypi-publish@release/v1
with:
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,14 @@ Repository does not have submodules or special cases. Clone is simple as:


## Build wheel
For wheel build is required a `wheel` module from PyPi:
For wheel build is required a `build` module from PyPi:

pip install wheel
pip install build

Open terminal and change directory to ayon-python-api repository and build wheel:

cd <REPOSITORY ROOT>/ayon-python-api
python setup.py sdist bdist_wheel
python -m build


Once finished a wheel should be created in `./dist/ayon_python_api-<VERSION>-py3-none-any`.
Expand Down
2 changes: 1 addition & 1 deletion docs/check_docstrings.bat
Original file line number Diff line number Diff line change
@@ -1 +1 @@
poetry run pydocstyle --convention=google --add-ignore=D103,D104,D100
pydocstyle --convention=google --add-ignore=D103,D104,D100
2 changes: 1 addition & 1 deletion docs/make_api.bat
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,5 @@

pushd %~dp0

poetry run sphinx-apidoc -f -e -M -o .\source\ ..\ayon_api\
sphinx-apidoc -f -e -M -o .\source\ ..\ayon_api\

2 changes: 1 addition & 1 deletion docs/make_html.bat
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

pushd %~dp0

poetry run sphinx-build -M html .\source .\build
sphinx-build -M html .\source .\build
9 changes: 9 additions & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Dependencies to build documentation
# pip install -r docs/requirements.txt
# revitron theme does not support Sphinx 7+
sphinx>=5.3.0,<7
revitron-sphinx-theme @ git+https://github.com/revitron/revitron-sphinx-theme.git@c0779c66365d9d258d93575ebaff7db9d3aee282
pydocstyle>=6.3.0
# ayon_api runtime dependencies (needed by autodoc to import the package)
requests>=2.27.1
Unidecode>=1.3.0
958 changes: 0 additions & 958 deletions poetry.lock

This file was deleted.

35 changes: 10 additions & 25 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -23,30 +23,15 @@ Repository = "https://github.com/ynput/ayon-python-api"
Changelog = "https://github.com/ynput/ayon-python-api/releases"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[tool.poetry]
name = "ayon_python_api"
version = "1.2.25-dev"
description = "AYON Python API"
authors = [
"ynput.io <info@ynput.io>"
]
packages = [
{ include = "ayon_api" },
{ include = "ayon_api/_api_helpers/*.py" },
]
[tool.setuptools]
packages = ["ayon_api", "ayon_api._api_helpers"]

[tool.poetry.dependencies]
python = ">=3.6.5"
requests = "^2.27"
Unidecode = "^1.3"

[tool.poetry.group.dev.dependencies]
sphinx = "*"
mock = "*"
sphinx-autoapi = "*"
revitron-sphinx-theme = { git = "https://github.com/revitron/revitron-sphinx-theme.git", branch = "master" }
pytest = "^6.2.5"
pydocstyle = "^6.3.0"
[dependency-groups]
dev = [
"mock",
"pytest>=6.2.5,<7",
"pydocstyle>=6.3.0",
]
37 changes: 0 additions & 37 deletions setup.py

This file was deleted.

Loading