Skip to content

Attempt to fix api-docs generation #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 11, 2024
Merged

Attempt to fix api-docs generation #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec9ce8f
Attempt to fix api-docs generation
souleb Oct 7, 2024
bbbfb02
Merge branch 'main' into attempt-fix-api-docs
souleb Oct 8, 2024
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
6 changes: 5 additions & 1 deletion .github/workflows/docs-ci.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,13 @@ jobs:
with:
repository: ${{ github.repository_owner }}/network-operator-docs # repo must be explicitly set here for workflow calling to behave correctly
token: ${{ inputs.token || secrets.GH_TOKEN_NVIDIA_CI_CD }} # token must be explicitly set here for push to work in following step
- name: Setup Go
uses: actions/setup-go@v5.0.2
with:
go-version: 1.23.x
- name: Make docs
run: |
make helm-docs generate-docs-versions-var api-docs
make api-docs helm-docs generate-docs-versions-var
- name: Close any existing documentation PRs
run: |
for pr_number in $(gh pr list --search "$PR_TITLE_PREFIX" --json number --jq ".[].number"); do
Expand Down
6 changes: 3 additions & 3 deletions docs/customizations/crds.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -657,13 +657,13 @@ NicClusterPolicySpec defines the desired state of NicClusterPolicy
| ``secondaryNetwork`` | Configuration options for secondary network |
| :ref:`SecondaryNetworkSpec <SecondaryNetworkSpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``nvIpam`` | Configuration options nv-ipam |
| ``nvIpam`` | Configuration options for nv-ipam |
| :ref:`NVIPAMSpec <NVIPAMSpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``nicFeatureDiscovery`` | Configuration options nic-feature-discovery |
| ``nicFeatureDiscovery`` | Configuration options for nic-feature-discovery |
| :ref:`NICFeatureDiscoverySpec <NICFeatureDiscoverySpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+
| ``docaTelemetryService`` | Configuration options DOCA Telemetry Service |
| ``docaTelemetryService`` | Configuration options for DOCA Telemetry Service |
| :ref:`DOCATelemetryServiceSpec <DOCATelemetryServiceSpec>` | |
+---------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------------+

Expand Down