poi-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From n...@apache.org
Subject svn commit: r1845345 - in /poi/site: README.txt build.xml
Date Wed, 31 Oct 2018 16:29:02 GMT
Author: nick
Date: Wed Oct 31 16:29:01 2018
New Revision: 1845345

URL: http://svn.apache.org/viewvc?rev=1845345&view=rev
Log:
Fix the docs task in the site subproject to successfully build and publish the site

Modified:
    poi/site/README.txt
    poi/site/build.xml

Modified: poi/site/README.txt
URL: http://svn.apache.org/viewvc/poi/site/README.txt?rev=1845345&r1=1845344&r2=1845345&view=diff
==============================================================================
--- poi/site/README.txt (original)
+++ poi/site/README.txt Wed Oct 31 16:29:01 2018
@@ -16,23 +16,23 @@ To generate the site for POI:
 
 3. set the POI_HOME environment variable to point to POI trunk. You will need it to build
javadocs
 
-4. modify documentation files in ./src
+4. to republish only the javadocs, run "ant javadocs", then commit the changes under ./publish/apidocs/dev/
 
-5. fetch the changelog from Bugzilla, and merge this with the changes file
+5. to update the site, first update documentation files in ./src/documentation/content/xdocs/
+
+6. fetch the changelog from Bugzilla, and merge this with the changes file
    cd src/documentation/content/xdocs
    python3 status.copy_module_from_bugzilla.py changes.xml status.xml
-   TODO Is this fully correct?
+   TODO Is this fully correct? Is this still needed?
 
-6. run "ant site" - it will generate the complete web site
-To build only javadocs run "ant javadocs"
-To build only from Forrest run "ant docs"
-   TODO Make this work, for now you need to run the ant task in the
-   parent main-POI project!
+7. run "ant site" - it will generate the complete web site
+   To build only Javadocs, run "ant javadocs"
+   To build only the html pages using Forrest, run "ant docs"
 	
-7. make sure you svn add any new files
+8. make sure you svn add any new files
 	svn status
 	svn add ...
 
-8. check in changes in src and publish
+9. check in changes in src and publish
 	svn ci
 

Modified: poi/site/build.xml
URL: http://svn.apache.org/viewvc/poi/site/build.xml?rev=1845345&r1=1845344&r2=1845345&view=diff
==============================================================================
--- poi/site/build.xml (original)
+++ poi/site/build.xml Wed Oct 31 16:29:01 2018
@@ -25,7 +25,7 @@ under the License.
     <property name="forrest.home" value="${env.FORREST_HOME}"/>
 
     <property name="main.documentation" value="src/documentation"/>
-    <property name="build.site" location="build/tmp/site/build/site"/>
+    <property name="build.site" location="build/site"/>
     <property name="build.site.src" location="build/tmp/site"/>
     <property name="apidocs.report.dir" location="${build.site}/apidocs/dev"/>
     <property name="apidocs.publish.dir" location="publish/apidocs/dev"/>
@@ -66,29 +66,16 @@ under the License.
 
     <target name="docs" depends="init, -check-forrest-installed, -check-docs"
             description="Builds the POI website">
-
-        <mkdir dir="${build.site.src}/${main.documentation}"/>
-        <copy todir="${build.site.src}/${main.documentation}">
-            <fileset dir="${main.documentation}"/>
-        </copy>
-        <copy file="forrest.properties" tofile="${build.site.src}/forrest.properties"/>
-
-        <move
-                file="${build.site.src}/src/documentation/content/xdocs/status.xml"
-                tofile="${build.site.src}/status.xml"/>
-
-        <antcall target="forrest.site">
-            <param name="project.home" location="${build.site.src}"/>
-        </antcall>
 <!--
-        <ant antfile="${env.FORREST_HOME}/forrest.antproxy.xml" target="site">
-            <property name="project.home" location="${build.site.src}"/>
-        </ant>
+        <copy file="${build.site.src}/src/documentation/content/xdocs/status.xml"
+              tofile="${build.site.src}/status.xml"/>
 -->
+        <!-- Run the main Project's Forrest task, but in our directory -->
+        <ant antfile="${env.POI_HOME}/build.xml" 
+             target="-forrest-docs"/>
+        <delete file="${build.site}/broken-links.xml"/>
 
-        <echo>Broken links:</echo>
-        <echo file="${build.site}/../tmp/brokenlinks.txt"/>
-        
+        <!-- Copy the result to be published -->
         <copy todir="publish">
            <fileset dir="${build.site}">
            </fileset>
@@ -99,7 +86,7 @@ under the License.
     <target name="javadocs" depends="-check-poi-home"
             description="Generates the API documentation">
         <ant dir="${env.POI_HOME}" antfile="build.xml" target="javadocs"/>
-        <copy todir="publish/apidocs/dev">
+        <copy todir="${apidocs.publish.dir}">
            <fileset dir="${apidocs.report.dir}">
            </fileset>
         </copy>
@@ -109,6 +96,5 @@ under the License.
     <!-- Generates documentation and reports -->
     <target name="site" depends="docs,javadocs"
             description="Generates POI's website's contents"/>
-
 </project>
 



---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@poi.apache.org
For additional commands, e-mail: commits-help@poi.apache.org


Mime
View raw message