CONTRIB: Automate update of API documentation #10333
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tvegas1
force-pushed
the
automate_update_api_doc
branch
from
4507466 to
9106af0
Compare
rakhmets
previously approved these changes
Nov 28, 2024
brminich
reviewed
Nov 29, 2024
contrib/api_update.sh
Outdated
|
|
||
| set -x | ||
|
|
||
| sudo yum -y install doxygen doxygen-latex |
There was a problem hiding this comment.
maybe also add support for ubuntu/debian?
tvegas1
force-pushed
the
automate_update_api_doc
branch
from
c808e5f to
e2261e3
Compare
|
@yosefe, can you please have a look? |
brminich
previously approved these changes
Jan 23, 2025
contrib/api_update.sh
Outdated
| @@ -0,0 +1,56 @@ | |||
| #!/usr/bin/env bash | |||
| # | |||
| # Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | |||
There was a problem hiding this comment.
Suggested change
| # Copyright (c) 2024 NVIDIA CORPORATION & AFFILIATES. All rights reserved. | |
| # Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved. |
brminich
previously approved these changes
Jan 23, 2025
yosefe
reviewed
Jan 25, 2025
contrib/api_update.sh
Outdated
| # See file LICENSE for terms. | ||
| # | ||
|
|
||
| set -euE |
There was a problem hiding this comment.
shall we pass it in the shebang?
contrib/api_update.sh
Outdated
|
|
||
| set -euE | ||
|
|
||
| branch="${1?Specify remote version to use like "upstream/v1.18.x"}" |
There was a problem hiding this comment.
need to document command line params
Comment on lines
+30
to
+49
| if grep -qi "debian\|ubuntu" /etc/os-release 2>/dev/null | ||
| then | ||
| sudo apt-get -y install doxygen doxygen-latex | ||
| else | ||
| sudo yum -y install doxygen doxygen-latex | ||
| fi | ||
|
|
||
| git checkout "$branch" | ||
| git clean -xdf | ||
| git reset --hard | ||
|
|
||
| ./autogen.sh | ||
| ./configure --with-docs-only | ||
| make docs | ||
|
|
||
| git checkout "$remote"/gh-pages | ||
| mkdir api/"$version" | ||
| ln -snf "$version" api/latest | ||
|
|
||
| cp docs/doxygen-doc/ucx.pdf "api/$version/ucx-$version.pdf" |
There was a problem hiding this comment.
seems we want to do this step as part of release pipeline when a GA version is tagged?
and run it on a docker image that has latest doxygen, latex, etc.
There was a problem hiding this comment.
as discussed, will address comment, add can be done in secondary commit
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Move steps from wiki to script to help avoid/fix mistakes. Wiki will need to be updated.
How?