apache/cloudstack
1
0
Fork 0
mirror of https://github.com/apache/cloudstack.git synced 2025-11-03 04:12:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

apidocs: Make the API documentation version not *hardcoded* to v4.9.0 (#3247)

Browse Source 
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:
Gabriel Beims Bräscher 2019-03-29 03:25:45 -03:00 committed by Rohit Yadav
parent fd541efe80
commit 6c841bf69b
4 changed files with 11 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
tools/apidoc/build-apidoc.sh
View File

@ -20,6 +20,8 @@
# cloud-build-api-doc.sh -- builds api documentation. # cloud-build-api-doc.sh -- builds api documentation.
#set -x #set -x
#set -u #set -u
ACS_RELEASE="$1"
shift
TARGETJARDIR="$1" TARGETJARDIR="$1"
shift shift
DEPSDIR="$1" DEPSDIR="$1"
@ -59,6 +61,8 @@ set -e
cp "$thisdir"/*.java . cp "$thisdir"/*.java .
cp "$thisdir"/*.xsl . cp "$thisdir"/*.xsl .
sed -e 's,%API_HEADER%,All APIs,g' "$thisdir/generatetoc_header.xsl" >generatetoc.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` PLATFORM=`uname -s`
if [[ "$PLATFORM" =~ .*WIN.* ]] if [[ "$PLATFORM" =~ .*WIN.* ]]

11
tools/apidoc/generatecommands.xsl
View File

@ -55,13 +55,12 @@ version="1.0">
<div class="api_titlebox"> <div class="api_titlebox">
<div class="api_titlebox_left"> <div class="api_titlebox_left">
<xsl:for-each select="command/command"> <xsl:for-each select="command/command">
<!-- Modify this line for the release version -->
<span> <span>
Apache CloudStack v4.9.0 Root Admin API Reference Apache CloudStack %ACS_RELEASE% Root Admin API Reference
</span> </span>
<p></p> <p></p>
<h1><xsl:value-of select="name"/></h1> <h1><xsl:value-of select="name"/></h1>
<p><xsl:value-of select="description"/></p> <p><xsl:value-of select="description"/></p>
</xsl:for-each> </xsl:for-each>
</div> </div>

3
tools/apidoc/generatetoc_header.xsl
View File

@ -51,8 +51,7 @@ version="1.0">
<div class="inside_apileftpanel"> <div class="inside_apileftpanel">
<div class="inside_contentpanel" style="width:930px;"> <div class="inside_contentpanel" style="width:930px;">
<!-- Modify this line for the release version --> <h1>Apache CloudStack API Documentation (%ACS_RELEASE%)</h1>
<h1>Apache CloudStack API Documentation (v4.9.0)</h1>
<a class="api_backbutton" href="http://cloudstack.apache.org/docs/api/"></a> <a class="api_backbutton" href="http://cloudstack.apache.org/docs/api/"></a>
<div class="apiannouncement_box"> <div class="apiannouncement_box">
<div class="apiannouncement_contentarea"> <div class="apiannouncement_contentarea">

1
tools/apidoc/pom.xml
View File

@ -63,6 +63,7 @@
<executable>bash</executable> <executable>bash</executable>
<arguments> <arguments>
<argument>./build-apidoc.sh</argument> <argument>./build-apidoc.sh</argument>
<armument>${project.version}</armument>
<argument>${client.config.jars}</argument> <argument>${client.config.jars}</argument>
<argument>${client.config.jars}</argument> <argument>${client.config.jars}</argument>
<argument>./target</argument> <argument>./target</argument>