mirror of
https://github.com/apache/cloudstack.git
synced 2025-10-26 08:42:29 +01:00
apidocs: Make the API documentation version not *hardcoded* to v4.9.0 (#3247)
This commit makes the API documentation automatically updated to the current project version. If one wants to set another version, it is possible by just editing the ACS_RELEASE variable in 'build-apidoc.sh'.
This commit is contained in:
parent
fd541efe80
commit
6c841bf69b
@ -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"
|
||||
@ -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.* ]]
|
||||
|
||||
@ -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>
|
||||
|
||||
|
||||
@ -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">
|
||||
|
||||
@ -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>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user