Skip to content

Commit 8380dd2

Browse files
authored
Improve API Reference pages (#1415)
**Pull Request Checklist** - [x] Fixes #1388. Closes #965 (as it's too nebulous to keep open, we should make new specific issues for anything remaining) - [x] Documentation/examples added - [x] [Good commit messages](https://cbea.ms/git-commit/) and/or PR title **Description of PR** Overhaul API reference docs: * Remove the `hera.md` file expanding the `hera.workflows` module (this was the page that loaded everything) * Add new sections for the API docs * Remove unused `admonition` extension * Tinker with other mkdocstrings settings for best docs experience * Update docstrings and add some object links and examples links --------- Signed-off-by: Elliot Gunton <elliotgunton@gmail.com>
1 parent b3399d3 commit 8380dd2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+436
-259
lines changed

docs/api/events/models.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,6 @@
33
## `hera.events.models`
44

55
::: hera.events.models.io.argoproj.events.v1alpha1
6+
options:
7+
inherited_members: false
8+
show_source: false

docs/api/workflows/hera.md

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

docs/api/workflows/models.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
1-
# Hera Workflows Auto-generated Models
1+
# Hera Workflows Auto-Generated Models
22

33
## `hera.workflows.models`
44

55
::: hera.workflows.models.io.argoproj.workflow.v1alpha1
6+
options:
7+
inherited_members: false
8+
show_source: false
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
::: hera.workflows.archive
2+
options:
3+
inherited_members: false
4+
show_source: false
5+
show_if_no_docstring: false
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
::: hera.workflows.artifact
2+
options:
3+
show_if_no_docstring: false
4+
members:
5+
- Artifact
6+
- ArtifactLoader
7+
- ArtifactoryArtifact
8+
- AzureArtifact
9+
- GCSArtifact
10+
- GitArtifact
11+
- HDFSArtifact
12+
- HTTPArtifact
13+
- OSSArtifact
14+
- RawArtifact
15+
- S3Artifact
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
::: hera.workflows.env
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
::: hera.workflows.env_from
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# First-Party Volumes
2+
3+
::: hera.workflows.volume
4+
options:
5+
head_level: 3
6+
show_root_heading: False
7+
members:
8+
- EmptyDirVolume
9+
- ExistingVolume
10+
- ConfigMapVolume
11+
- DownwardAPIVolume
12+
- EphemeralVolume
13+
- FlexVolume
14+
- SecretVolume
15+
- HostPathVolume
16+
- NFSVolume
17+
- ProjectedVolume
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
::: hera.workflows.metrics
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
::: hera.workflows.parameter

0 commit comments

Comments
 (0)