Skip to content

Commit 735e69a

Browse files
authored
Doc fixes (#27228)
### Description <!-- Describe your changes. --> - Run API doc generation pipelines weekly and update retention time to be within repo limits (10 days). The pipelines have warnings like this: `Warning: Retention days cannot be greater than the maximum allowed retention set within the repository. Using 10 instead.` - Fix link to plugin EP docs page. ### Motivation and Context <!-- - Why is this change required? What problem does it solve? - If it fixes an open issue, please link to the issue here. --> The API doc generation pipelines were scheduled too infrequently (twice a month) compared to the artifact retention period (10 days), so the artifacts could expire. Fix a broken link.
1 parent 301aaf5 commit 735e69a

File tree

7 files changed

+14
-14
lines changed

7 files changed

+14
-14
lines changed

.github/workflows/publish-c-apidocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
- include/onnxruntime/core/session/**
1010
- orttraining/orttraining/training_api/include/**
1111
schedule:
12-
- cron: '0 0 1,15 * *'
12+
- cron: '0 0 * * 0'
1313
workflow_dispatch:
1414

1515
concurrency:
@@ -53,4 +53,4 @@ jobs:
5353
with:
5454
name: onnxruntime-c-apidocs
5555
path: _site
56-
retention-days: 30
56+
retention-days: 10

.github/workflows/publish-csharp-apidocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
paths:
99
- csharp/**
1010
schedule:
11-
- cron: '0 0 1,15 * *'
11+
- cron: '0 0 * * 0'
1212
workflow_dispatch:
1313

1414
concurrency:
@@ -64,4 +64,4 @@ jobs:
6464
with:
6565
name: onnxruntime-csharp-apidocs
6666
path: _site
67-
retention-days: 30
67+
retention-days: 10

.github/workflows/publish-java-apidocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
paths:
99
- java/**
1010
schedule:
11-
- cron: '0 0 1,15 * *'
11+
- cron: '0 0 * * 0'
1212
workflow_dispatch:
1313

1414
concurrency:
@@ -51,4 +51,4 @@ jobs:
5151
with:
5252
name: onnxruntime-java-apidocs
5353
path: _site
54-
retention-days: 30
54+
retention-days: 10

.github/workflows/publish-js-apidocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
paths:
99
- js/common/**
1010
schedule:
11-
- cron: '0 0 1,15 * *'
11+
- cron: '0 0 * * 0'
1212
workflow_dispatch:
1313

1414
concurrency:
@@ -51,4 +51,4 @@ jobs:
5151
with:
5252
name: onnxruntime-node-apidocs
5353
path: _site
54-
retention-days: 30
54+
retention-days: 10

.github/workflows/publish-objectivec-apidocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ on:
88
paths:
99
- objectivec/**
1010
schedule:
11-
- cron: '0 0 1,15 * *'
11+
- cron: '0 0 * * 0'
1212
workflow_dispatch:
1313

1414
concurrency:
@@ -56,4 +56,4 @@ jobs:
5656
with:
5757
name: onnxruntime-objectivec-apidocs
5858
path: ./_site
59-
retention-days: 30
59+
retention-days: 10

.github/workflows/publish-python-apidocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ on:
99
- onnxruntime/python/**
1010
- docs/python/**
1111
schedule:
12-
- cron: '0 0 1,15 * *'
12+
- cron: '0 0 * * 0'
1313
workflow_dispatch:
1414

1515
concurrency:
@@ -58,4 +58,4 @@ jobs:
5858
with:
5959
name: onnxruntime-python-apidocs
6060
path: _site
61-
retention-days: 30
61+
retention-days: 10

onnxruntime/test/autoep/library/readme.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ used for testing and as reference examples.
1919
used for cross compiling models for different targets.
2020

2121
- `example_plugin_ep_kernel_registry/`
22-
Contains a basic plugin execution provider that registers operator kernels with ONNX Runtime, as opposed to compiling
22+
Contains a basic plugin execution provider that registers operator kernels with ONNX Runtime, as opposed to compiling
2323
nodes.
2424

2525
- `plugin_ep_utils.h`
@@ -39,4 +39,4 @@ used for testing and as reference examples.
3939
---
4040

4141
For more information, see the ONNX Runtime documentation on
42-
[plugin execution providers](https://onnxruntime.ai/docs/execution-providers/plugin-ep-libraries.html).
42+
[plugin execution providers](https://onnxruntime.ai/docs/execution-providers/plugin-ep-libraries/).

0 commit comments

Comments
 (0)