Skip to content

Commit 4d8f078

Browse files
Merge pull request #169 from KhiopsML/dev
Release 10.2.1.0
2 parents e8b80ee + b8d5962 commit 4d8f078

86 files changed

Lines changed: 955 additions & 49529 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
---
2-
name: Build (and deploy) API docs to GH Pages
2+
name: API Docs
33
on:
4-
push:
5-
tags: [v*]
64
workflow_dispatch:
5+
inputs:
6+
deploy-gh-pages:
7+
description: Deploy GH Pages
8+
required: true
9+
type: boolean
10+
default: false
711
pull_request:
812
paths:
913
- doc/**.rst
1014
- doc/create-doc
1115
- doc/clean-doc
1216
- doc/*.py
1317
- khiops/**.py
18+
- .github/workflows/api-docs.yml
1419
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
1520
permissions:
1621
contents: read
@@ -24,8 +29,7 @@ concurrency:
2429
group: pages
2530
cancel-in-progress: false
2631
jobs:
27-
create-docs:
28-
name: Create Sphinx docs
32+
build:
2933
runs-on: ubuntu-22.04
3034
container:
3135
image: ghcr.io/khiopsml/khiops-python/khiopspydev-ubuntu22.04:latest
@@ -34,11 +38,11 @@ jobs:
3438
options: --user 1001
3539
steps:
3640
- name: Checkout khiops-python
37-
uses: actions/checkout@v4.1.0
41+
uses: actions/checkout@v4
3842
with:
3943
fetch-depth: 0
4044
- name: Checkout khiops-python-tutorial
41-
uses: actions/checkout@v4.1.0
45+
uses: actions/checkout@v4
4246
with:
4347
repository: khiopsml/khiops-python-tutorial
4448
path: doc/khiops-python-tutorial
@@ -54,37 +58,25 @@ jobs:
5458
# Install the doc python requirements
5559
cd doc
5660
pip3 install -U -r requirements.txt
57-
- name: Obtain Sphinx dependencies
58-
run: |
5961
- name: Build Sphinx Documentation
6062
run: |
6163
cd doc
6264
./create-doc -t
6365
- name: Upload the docs as an artifact
64-
uses: actions/upload-artifact@v3.1.3
66+
uses: actions/upload-pages-artifact@v3
6567
with:
66-
name: khiops-python-docs
6768
path: doc/_build/html/
68-
upload-docs:
69-
name: Upload docs to GH pages
70-
if: github.event_name == 'push'
69+
# Deploy only when the user explicitly (and manually) orders it
70+
deploy:
71+
if: ${{ github.event_name == 'workflow_dispatch' || inputs.deploy-gh-pages == true }}
7172
runs-on: ubuntu-latest
72-
needs: create-docs
73+
needs: build
7374
environment:
7475
name: github-pages
7576
url: ${{ steps.deployment.outputs.page_url }}
7677
steps:
7778
- name: Setup Pages
78-
uses: actions/configure-pages@v3
79-
- name: Download artifact
80-
uses: actions/download-artifact@v3.0.2
81-
with:
82-
name: khiops-python-docs
83-
path: kp-docs
84-
- name: Upload docsas pages artifact
85-
uses: actions/upload-pages-artifact@v2
86-
with:
87-
path: kp-docs
88-
- name: Deploy to GitHub Pages
79+
uses: actions/configure-pages@v4
80+
- name: Deploy API Docs to GitHub Pages
8981
id: deployment
90-
uses: actions/deploy-pages@v2
82+
uses: actions/deploy-pages@v4

.github/workflows/build-dev-container-on-push.yml

Lines changed: 0 additions & 13 deletions
This file was deleted.

.github/workflows/build-dev-container.yml

Lines changed: 0 additions & 75 deletions
This file was deleted.

.github/workflows/build-pip-package.yml

Lines changed: 0 additions & 71 deletions
This file was deleted.

0 commit comments

Comments
 (0)