From 3e56bdb179c9b2f647da46a211f80edab9016750 Mon Sep 17 00:00:00 2001 From: Oskar Stark Date: Thu, 6 Feb 2020 08:32:24 +0100 Subject: [PATCH 1/4] Use GithubAction instead of Travis for building the docs --- .github/workflows/ci.yaml | 35 +++++++++++++++++++++++++++++++++++ .travis.yml | 15 --------------- 2 files changed, 35 insertions(+), 15 deletions(-) create mode 100644 .github/workflows/ci.yaml delete mode 100644 .travis.yml diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml new file mode 100644 index 00000000000..c0d52481fac --- /dev/null +++ b/.github/workflows/ci.yaml @@ -0,0 +1,35 @@ +on: + push: + branches-ignore: + - 'github-comments' + pull_request: + branches-ignore: + - 'github-comments' + +name: CI + +jobs: + build: + name: Build + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: Set up Python 3.x + uses: actions/setup-python@v1 + with: + python-version: '3.7' # Semantic version range syntax or exact version of a Python version + - name: Display Python version + run: python -c "import sys; print(sys.version)" + - run: sudo apt-get install python-dev build-essential + - run: pip install --user sphinx + - run: pip install -r _build/.requirements.txt + - run: make -C _build SPHINXOPTS=-nW html + doctor-rst: + name: DOCtor-RST + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - name: DOCtor-RST + uses: docker://oskarstark/doctor-rst + with: + args: --short diff --git a/.travis.yml b/.travis.yml deleted file mode 100644 index 8ed2088e6ee..00000000000 --- a/.travis.yml +++ /dev/null @@ -1,15 +0,0 @@ -language: python - -python: 2.7 - -sudo: false -cache: - directories: [$HOME/.cache/pip] - -install: pip install -r _build/.requirements.txt - -script: make -C _build SPHINXOPTS=-nW html - -branches: - except: - - github-comments From 948728ea9503120193e62bf48250e286b57ad3c6 Mon Sep 17 00:00:00 2001 From: Oskar Stark Date: Thu, 6 Feb 2020 09:23:19 +0100 Subject: [PATCH 2/4] Use one workflow file --- .github/workflows/lint.yaml | 12 ------------ 1 file changed, 12 deletions(-) delete mode 100644 .github/workflows/lint.yaml diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml deleted file mode 100644 index ada570e342c..00000000000 --- a/.github/workflows/lint.yaml +++ /dev/null @@ -1,12 +0,0 @@ -on: [push, pull_request] -name: Lint -jobs: - doctor-rst: - name: DOCtor-RST - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@master - - name: DOCtor-RST - uses: docker://oskarstark/doctor-rst - with: - args: --short From e5d0cad77612e48bd940a1c673a32f4384864594 Mon Sep 17 00:00:00 2001 From: Oskar Stark Date: Mon, 10 Feb 2020 08:32:24 +0100 Subject: [PATCH 3/4] Formatting + name steps --- .github/workflows/ci.yaml | 30 ++++++++++++++++++------------ 1 file changed, 18 insertions(+), 12 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index c0d52481fac..a019ca7a1ca 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -13,23 +13,29 @@ jobs: name: Build runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - name: Set up Python 3.x + - name: "Checkout" + uses: actions/checkout@v2 + - name: "Set up Python 3.x" uses: actions/setup-python@v1 with: python-version: '3.7' # Semantic version range syntax or exact version of a Python version - - name: Display Python version + - name: "Display Python version" run: python -c "import sys; print(sys.version)" - - run: sudo apt-get install python-dev build-essential - - run: pip install --user sphinx - - run: pip install -r _build/.requirements.txt - - run: make -C _build SPHINXOPTS=-nW html + - name: "Install Sphinx dependencies" + run: sudo apt-get install python-dev build-essential + - name: "Install Sphinx" + run: pip install --user sphinx + - name: "INstall custom requirements via pip" + run: pip install -r _build/.requirements.txt + - name: "Build documentation" + run: make -C _build SPHINXOPTS=-nW html doctor-rst: name: DOCtor-RST runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - name: DOCtor-RST - uses: docker://oskarstark/doctor-rst - with: - args: --short + - name: "Checkout" + uses: actions/checkout@v2 + - name: "Run DOCtor-RST" + uses: docker://oskarstark/doctor-rst + with: + args: --short From 0084ec2298d20fcf9c3122d36793c900842073f7 Mon Sep 17 00:00:00 2001 From: Oskar Stark Date: Mon, 10 Feb 2020 09:23:01 +0100 Subject: [PATCH 4/4] Address comments by @localheinzwq --- .github/workflows/ci.yaml | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index a019ca7a1ca..49aecd4fd34 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -11,30 +11,42 @@ name: CI jobs: build: name: Build + runs-on: ubuntu-latest + steps: - name: "Checkout" uses: actions/checkout@v2 + - name: "Set up Python 3.x" uses: actions/setup-python@v1 with: python-version: '3.7' # Semantic version range syntax or exact version of a Python version + - name: "Display Python version" run: python -c "import sys; print(sys.version)" + - name: "Install Sphinx dependencies" run: sudo apt-get install python-dev build-essential + - name: "Install Sphinx" run: pip install --user sphinx - - name: "INstall custom requirements via pip" + + - name: "Install custom requirements via pip" run: pip install -r _build/.requirements.txt + - name: "Build documentation" run: make -C _build SPHINXOPTS=-nW html + doctor-rst: name: DOCtor-RST + runs-on: ubuntu-latest + steps: - name: "Checkout" uses: actions/checkout@v2 + - name: "Run DOCtor-RST" uses: docker://oskarstark/doctor-rst with: