Skip to content

Make the API documentation version not *hardcoded* to v4.9.0 #3247

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
yadvr merged 2 commits into from
Mar 29, 2019
Merged

Make the API documentation version not *hardcoded* to v4.9.0 #3247

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
7368cc0
Currently the API documentation is *hardcoded* to v4.9.0
Mar 28, 2019
6c01687
Remove line <!-- Modify this line for the release version -->
Mar 28, 2019
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
4 changes: 4 additions & 0 deletions tools/apidoc/build-apidoc.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
# cloud-build-api-doc.sh -- builds api documentation.
#set -x
#set -u
ACS_RELEASE="$1"
shift
TARGETJARDIR="$1"
shift
DEPSDIR="$1"
Expand Down Expand Up @@ -59,6 +61,8 @@ set -e
cp "$thisdir"/*.java .
cp "$thisdir"/*.xsl .
sed -e 's,%API_HEADER%,All APIs,g' "$thisdir/generatetoc_header.xsl" >generatetoc.xsl
sed -i "s/%ACS_RELEASE%/${ACS_RELEASE}/g" generatetoc.xsl
sed -i "s/%ACS_RELEASE%/${ACS_RELEASE}/g" generatecommands.xsl

PLATFORM=`uname -s`
if [[ "$PLATFORM" =~ .*WIN.* ]]
Expand Down
11 changes: 5 additions & 6 deletions tools/apidoc/generatecommands.xsl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,13 +55,12 @@ version="1.0">
<div class="api_titlebox">
<div class="api_titlebox_left">
<xsl:for-each select="command/command">
<!-- Modify this line for the release version -->
<span>
Apache CloudStack v4.9.0 Root Admin API Reference
</span>
<p></p>
<h1><xsl:value-of select="name"/></h1>
<p><xsl:value-of select="description"/></p>
Apache CloudStack %ACS_RELEASE% Root Admin API Reference
</span>
<p></p>
<h1><xsl:value-of select="name"/></h1>
<p><xsl:value-of select="description"/></p>
</xsl:for-each>
</div>

Expand Down
3 changes: 1 addition & 2 deletions tools/apidoc/generatetoc_header.xsl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@ version="1.0">

<div class="inside_apileftpanel">
<div class="inside_contentpanel" style="width:930px;">
<!-- Modify this line for the release version -->
<h1>Apache CloudStack API Documentation (v4.9.0)</h1>
<h1>Apache CloudStack API Documentation (%ACS_RELEASE%)</h1>
<a class="api_backbutton" href="http://cloudstack.apache.org/docs/api/"></a>
<div class="apiannouncement_box">
<div class="apiannouncement_contentarea">
Expand Down
1 change: 1 addition & 0 deletions tools/apidoc/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
<executable>bash</executable>
<arguments>
<argument>./build-apidoc.sh</argument>
<armument>${project.version}</armument>
<argument>${client.config.jars}</argument>
<argument>${client.config.jars}</argument>
<argument>./target</argument>
Expand Down