From 818c1313e84ffb67375d7fb13527ab5867856c4c Mon Sep 17 00:00:00 2001 From: Patrick Kanzler <4189642+patkan@users.noreply.github.com> Date: Mon, 28 Sep 2020 20:55:13 +0200 Subject: [PATCH 01/12] Build documentation in Github action --- .github/workflows/documentation.yml | 33 +++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 .github/workflows/documentation.yml diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml new file mode 100644 index 0000000..fd85eaa --- /dev/null +++ b/.github/workflows/documentation.yml @@ -0,0 +1,33 @@ +# This is a basic workflow to help you get started with Actions + +name: Documentation build + +# Controls when the action will run. Triggers the workflow on push or pull request +# events but only for the master branch +on: + push: + branches: [ master ] + pull_request: + branches: [ master ] + +# A workflow run is made up of one or more jobs that can run sequentially or in parallel +jobs: + # This workflow contains a single job called "build" + build: + # The type of runner that the job will run on + runs-on: ubuntu-latest + + # Steps represent a sequence of tasks that will be executed as part of the job + steps: + # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it + - uses: actions/checkout@v2 + + - name: Sphinx Build + # You may pin to the exact commit or the version. + # uses: ammaraskar/sphinx-action@8b4f60114d7fd1faeba1a712269168508d4750d2 + uses: ammaraskar/sphinx-action@0.4 + with: + # The folder containing your sphinx docs. + docs-folder: doc/ + # The command used to build your documentation. + build-command: make html From 8488fafd757ebd89c5630b0706d28f04581c4fba Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Mon, 28 Sep 2020 20:59:36 +0200 Subject: [PATCH 02/12] remove travis config fixes #389 --- .travis.yml | 79 ----------------------------------------------------- 1 file changed, 79 deletions(-) delete mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index f417023..0000000 --- a/.travis.yml +++ /dev/null @@ -1,79 +0,0 @@ -language: python -sudo: false -cache: pip -dist: bionic -git: - depth: 100000 -addons: - apt: - packages: - - graphviz - - libenchant1c2a -matrix: - fast_finish: true - include: - - name: "Python 3.7 on Windows" - os: windows - language: shell - before_install: - - choco install python - - pip install tox codecov 'sphinx>=1.5.1' 'sphinxcontrib-spelling>=5' - env: - - TOXENV=py37 - - PATH=/c/Python37:/c/Python37/Scripts:$PATH - - ESCPOS_CAPABILITIES_FILE=C:/Users/travis/build/python-escpos/python-escpos/capabilities-data/dist/capabilities.json - - name: "Python 3.7 on macOS" - os: osx - osx_image: xcode10.2 - language: shell - env: TOXENV=py37 ESCPOS_CAPABILITIES_FILE=/Users/travis/build/python-escpos/python-escpos/capabilities-data/dist/capabilities.json - - python: 3.5 - env: TOXENV=py35 - - python: 3.6 - env: TOXENV=py36 - - python: 3.7 - env: TOXENV=py37 - - python: 3.7-dev - env: TOXENV=py37 - - python: 3.8 - env: TOXENV=py38 - - python: 3.8-dev - env: TOXENV=py38 - - python: nightly - env: TOXENV=py38 - - python: pypy3 - env: TOXENV=pypy3 - - python: 3.8 - env: TOXENV=docs - - python: 3.8 - env: TOXENV=flake8 - allow_failures: - - python: 3.7-dev - - python: 3.8-dev - - python: nightly - - python: pypy3 - - os: windows - - os: osx -before_install: - - pip install tox codecov 'sphinx>=1.5.1' 'sphinxcontrib-spelling>=5' - - ./doc/generate_authors.sh --check -script: - - tox - - codecov -notifications: - email: - on_success: never - on_failure: change -deploy: -# Github deployment - - provider: releases - api_key: - secure: oiR3r5AIx9ENIRtbUKIxorRx8GMv4BxgVIZcieXbgSTN4DBZdRWdzs1Xxngu/90Xf79G0X+XGxZyXrYN7eFFNp0kUYj8kwZ1aS/dyR88scskumERWi1Hv5WUJrYGrDe7PcjNGsJ2jw0nNnRPKG87Y84aR4lQygyGBSlDcdrOBnBv0sHYJMxRvHSRkGgWpur06QIOGOk4oOipTXR/7E9cg3YQC5nvZAf2QiprwTa8IcOSFlZQPykEVRYSiAgXrgqBYcZzpX0hAGuIBv7DmPI2ORTF+t79Wbhxhnho3gGJleDv7Z96//sf1vQNCG6qOgeIc9ZY08Jm1AwXQoW0p6F1/XcEPxeyPDkXJzlojE9rjYNLCPL4gxb/LESEuUafm0U4JGMsZ6hnsBOw583yTuAdfQuJ9M+QaSyem6OVNkky3+DKAD3z0WJnl9jmGXIXigNSIxD25XhpvY+j9P0XTLBG1GT2Q+wXCIjSYJc2XnYcdgVJcLoxSWk1fKj/KPi7buAWtqwnL3tjeldpMMOZMliPUTWMM14zoGskHztt0JCkAtcotm9AQtvL8eZ2LHLDK/jyLzjv0wAwU5vzSVp14XHLZl7Q0AIoNc20p1EYGa9C/gSPd9CkrWZoG4lMOiAu3tp2PRLVrdXH3ZWSPQq4Ek5MczrUTkmB82XErNbOa8QB1Dw= - file: .tox/dist/python-escpos*.zip - file_glob: true - skip_cleanup: true - on: - tags: true - repo: python-escpos/python-escpos - branch: master - condition: $TRAVIS_PYTHON_VERSION = "3.8" From d390449400e1f6914c0ed7fecb8b4ccbe7a4a273 Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Mon, 28 Sep 2020 21:06:45 +0200 Subject: [PATCH 03/12] change documenatation action --- .github/workflows/documentation.yml | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index fd85eaa..8061c58 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -19,15 +19,7 @@ jobs: # Steps represent a sequence of tasks that will be executed as part of the job steps: - # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it - uses: actions/checkout@v2 - - - name: Sphinx Build - # You may pin to the exact commit or the version. - # uses: ammaraskar/sphinx-action@8b4f60114d7fd1faeba1a712269168508d4750d2 - uses: ammaraskar/sphinx-action@0.4 + - uses: ammaraskar/sphinx-action@0.4 with: - # The folder containing your sphinx docs. - docs-folder: doc/ - # The command used to build your documentation. - build-command: make html + docs-folder: "doc/" \ No newline at end of file From 8ece137789e5c676ebcfc7133eaeeaa5a8dc04a1 Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Mon, 28 Sep 2020 21:12:44 +0200 Subject: [PATCH 04/12] tr< checkout v1 --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 8061c58..04e2f54 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -19,7 +19,7 @@ jobs: # Steps represent a sequence of tasks that will be executed as part of the job steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v1 - uses: ammaraskar/sphinx-action@0.4 with: docs-folder: "doc/" \ No newline at end of file From 04e0a0ce4713fc21125b3ce87027c967143ea237 Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Mon, 28 Sep 2020 21:14:56 +0200 Subject: [PATCH 05/12] Revert "tr< checkout v1" This reverts commit 8ece137789e5c676ebcfc7133eaeeaa5a8dc04a1. --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 04e2f54..8061c58 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -19,7 +19,7 @@ jobs: # Steps represent a sequence of tasks that will be executed as part of the job steps: - - uses: actions/checkout@v1 + - uses: actions/checkout@v2 - uses: ammaraskar/sphinx-action@0.4 with: docs-folder: "doc/" \ No newline at end of file From a8941b4a3ed24f8f22db0baec4d6ae49b6cea187 Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Mon, 28 Sep 2020 21:15:33 +0200 Subject: [PATCH 06/12] check out submodules --- .github/workflows/documentation.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 8061c58..cfa0a2f 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -20,6 +20,8 @@ jobs: # Steps represent a sequence of tasks that will be executed as part of the job steps: - uses: actions/checkout@v2 + with: + submodules: 'recursive' - uses: ammaraskar/sphinx-action@0.4 with: docs-folder: "doc/" \ No newline at end of file From 21b9dba34586b8d1e638459f41d5044dbcc2957b Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Mon, 28 Sep 2020 21:22:54 +0200 Subject: [PATCH 07/12] have a look around before building doc --- .github/workflows/documentation.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index cfa0a2f..8c6e3fb 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -24,4 +24,5 @@ jobs: submodules: 'recursive' - uses: ammaraskar/sphinx-action@0.4 with: - docs-folder: "doc/" \ No newline at end of file + docs-folder: "doc/" + pre-build-command: "ls -al" \ No newline at end of file From 243eb48b387e09d7d9796042a823e72a1c6a7204 Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Mon, 28 Sep 2020 21:26:42 +0200 Subject: [PATCH 08/12] install git in container --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 8c6e3fb..bb69bf3 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -25,4 +25,4 @@ jobs: - uses: ammaraskar/sphinx-action@0.4 with: docs-folder: "doc/" - pre-build-command: "ls -al" \ No newline at end of file + pre-build-command: "apt-get update -y && apt-get install -y git" \ No newline at end of file From 247211d0cedc97c706ca65e274e20786771757b5 Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Mon, 28 Sep 2020 21:31:29 +0200 Subject: [PATCH 09/12] install sphinx --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index bb69bf3..e472df9 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -25,4 +25,4 @@ jobs: - uses: ammaraskar/sphinx-action@0.4 with: docs-folder: "doc/" - pre-build-command: "apt-get update -y && apt-get install -y git" \ No newline at end of file + pre-build-command: "apt-get update -y && apt-get install -y git sphinx" \ No newline at end of file From 1dc79baf82e0cc26d7134f4f66b48aecf41af9d0 Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Mon, 28 Sep 2020 21:33:16 +0200 Subject: [PATCH 10/12] rename job --- .github/workflows/documentation.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index e472df9..75deb87 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -12,8 +12,8 @@ on: # A workflow run is made up of one or more jobs that can run sequentially or in parallel jobs: - # This workflow contains a single job called "build" - build: + # This workflow contains a single job called "docs" + docs: # The type of runner that the job will run on runs-on: ubuntu-latest From 5d62be2be97822a211f39e72c8ffaefb0aeaebdd Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Mon, 28 Sep 2020 22:28:27 +0200 Subject: [PATCH 11/12] install graphviz and libenchant --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 75deb87..c855eb8 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -25,4 +25,4 @@ jobs: - uses: ammaraskar/sphinx-action@0.4 with: docs-folder: "doc/" - pre-build-command: "apt-get update -y && apt-get install -y git sphinx" \ No newline at end of file + pre-build-command: "apt-get update -y && apt-get install -y git sphinx graphviz libenchant1c2a" \ No newline at end of file From 18cc1a268a29f857d325bf1358063b3c07270c2c Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Mon, 28 Sep 2020 22:31:48 +0200 Subject: [PATCH 12/12] use corrct name for sphinx package --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index c855eb8..6696c6d 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -25,4 +25,4 @@ jobs: - uses: ammaraskar/sphinx-action@0.4 with: docs-folder: "doc/" - pre-build-command: "apt-get update -y && apt-get install -y git sphinx graphviz libenchant1c2a" \ No newline at end of file + pre-build-command: "apt-get update -y && apt-get install -y git python3-sphinx graphviz libenchant1c2a" \ No newline at end of file