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
2 changes: 0 additions & 2 deletions .github/workflows/dist.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,12 @@ on:
push:
branches:
- main
- develop
tags:
- "v*.*.*"

pull_request:
branches:
- main
- develop

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
Expand Down
4 changes: 1 addition & 3 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@ on:
push:
branches:
- main
- develop
tags:
- "v*.*.*"

pull_request:
branches:
- main
- develop

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
Expand Down Expand Up @@ -40,7 +38,7 @@ jobs:
CI: false
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PAGES_BRANCH: gh-pages
if: (contains(github.ref, 'develop') || contains(github.ref, 'main')) && github.event_name == 'push'
if: contains(github.ref, 'main') && github.event_name == 'push'
run: |
git config user.name doc-bot
git config user.email doc-bot@openml.com
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release_docker.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ on:
workflow_dispatch:
push:
branches:
- 'develop'
- 'main'
- 'docker'
tags:
- 'v*'
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,12 @@ on:
push:
branches:
- main
- develop
tags:
- "v*.*.*"

pull_request:
branches:
- main
- develop

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
Expand Down
9 changes: 1 addition & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,7 @@ in the PR description.

The preferred workflow for contributing to openml-python is to
fork the [main repository](https://github.com/openml/openml-python) on
GitHub, clone, check out the branch `main`, and develop on a new branch
branch. Steps:
GitHub, clone, and develop on a new branch:

0. Make sure you have git installed, and a GitHub account.

Expand All @@ -171,12 +170,6 @@ local disk:
cd openml-python
```

3. Switch to the ``develop`` branch:

```bash
git checkout main
```

3. Create a ``feature`` branch to hold your development changes:

```bash
Expand Down
10 changes: 5 additions & 5 deletions docker/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,10 @@ docker run -v PATH/TO/FILE:/openml/MY_SCRIPT.py openml/openml-python MY_SCRIPT.p
You can run the unit tests by passing `test` as the first argument.
It also requires a local or remote repository to be specified, which is explained
[below]((#using-local-or-remote-code). For this example, we specify to test the
`develop` branch:
`my-feature` branch:

```text
docker run openml/openml-python test develop
docker run openml/openml-python test my-feature
```

### Building documentation
Expand All @@ -56,16 +56,16 @@ You can build the documentation by passing `doc` as the first argument,
you should [mount]((https://docs.docker.com/storage/bind-mounts/#start-a-container-with-a-bind-mount))
an output directory in which the docs will be stored. You also need to provide a remote
or local repository as explained in [the section below]((#using-local-or-remote-code).
In this example, we build documentation for the `develop` branch.
In this example, we build documentation for the `my-feature` branch.
On Windows:

```text
docker run --mount type=bind,source="E:\\files/output",destination="/output" openml/openml-python doc develop
docker run --mount type=bind,source="E:\\files/output",destination="/output" openml/openml-python doc my-feature
```

on Linux:
```text
docker run --mount type=bind,source="./output",destination="/output" openml/openml-python doc develop
docker run --mount type=bind,source="./output",destination="/output" openml/openml-python doc my-feature
```

see [the section below]((#using-local-or-remote-code) for running against local changes
Expand Down
3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,8 @@ docs=[
"mkdocs-section-index",
"mkdocs-jupyter",
"mkdocs-linkcheck",
"mike"
"mike",
"pymdown-extensions<12.2", # 2026-10-10: incompatibility of 12.2 with mkdocstrings
]

[project.urls]
Expand Down
Loading