Skip to content

[doc] update Sphinx configuration#2013

Merged
k8s-ci-robot merged 2 commits intokubernetes-client:masterfrom
tomplus:feat/update-doc
Feb 27, 2023
Merged

[doc] update Sphinx configuration#2013
k8s-ci-robot merged 2 commits intokubernetes-client:masterfrom
tomplus:feat/update-doc

Conversation

@tomplus
Copy link
Copy Markdown
Member

@tomplus tomplus commented Feb 19, 2023

What type of PR is this?

Update Sphinx configuration by:

  1. Remove stale files
  2. Use sphinx-apidoc to generate content for sphinx autodoc to have it up-to-date
  3. Fix links in files: README, CONTRIBUTING

/kind documentation

What this PR does / why we need it:

Which issue(s) this PR fixes:

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

NONE

@k8s-ci-robot k8s-ci-robot added the kind/documentation Categorizes issue or PR as related to documentation. label Feb 19, 2023
@k8s-ci-robot k8s-ci-robot added do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Feb 19, 2023
tomplus
tomplus commented Feb 19, 2023
View reviewed changes
Comment thread doc/.gitignore
@@ -0,0 +1,4 @@
source/README.md
source/CONTRIBUTING.md
source/kubernetes.*
Copy link
Copy Markdown
Member Author

@tomplus tomplus Feb 19, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've removed "kubernetes.*.rst" files, there are generated by sphinx-apidoc during building process.

@tomplus
Copy link
Copy Markdown
Member Author

tomplus commented Feb 19, 2023

Tests fail due to #2014

@roycaihw
Copy link
Copy Markdown
Member

roycaihw commented Feb 27, 2023

/assign @yliaog

@yliaog
Copy link
Copy Markdown
Contributor

yliaog commented Feb 27, 2023

/lgtm
/aprove

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 27, 2023
@yliaog
Copy link
Copy Markdown
Contributor

yliaog commented Feb 27, 2023

/approve

@yliaog
Copy link
Copy Markdown
Contributor

yliaog commented Feb 27, 2023

/release-note-none

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Feb 27, 2023

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: tomplus, yliaog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. approved Indicates a PR has been approved by an approver from all required OWNERS files. and removed do-not-merge/release-note-label-needed Indicates that a PR should not merge because it's missing one of the release note labels. labels Feb 27, 2023
@yliaog
Copy link
Copy Markdown
Contributor

yliaog commented Feb 27, 2023

/close

@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Feb 27, 2023

@yliaog: Closed this PR.

Details

In response to this:

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@yliaog
Copy link
Copy Markdown
Contributor

yliaog commented Feb 27, 2023

/reopen

@k8s-ci-robot k8s-ci-robot reopened this Feb 27, 2023
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

k8s-ci-robot commented Feb 27, 2023

@yliaog: Reopened this PR.

Details

In response to this:

/reopen

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot merged commit 617e5f5 into kubernetes-client:master Feb 27, 2023
@tomplus tomplus mentioned this pull request Mar 5, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@roycaihw roycaihw Awaiting requested review from roycaihw

@yliaog yliaog Awaiting requested review from yliaog

Assignees

@yliaog yliaog

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@tomplus @roycaihw @yliaog @k8s-ci-robot