docs.gradle 2.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  1. // Docbook and Javadoc building and uploading tasks
  2. apply plugin: 'base'
  3. task docs {
  4. dependsOn 'manual:docbook', 'faq:docbookHtmlSingle', 'apidocs'
  5. }
  6. subprojects {
  7. apply plugin: 'base'
  8. apply plugin: 'docbook'
  9. docbookHtmlSingle.stylesheet = new File(projectDir, 'src/xsl/html-single-custom.xsl')
  10. }
  11. project('faq') {
  12. defaultTasks 'docbookHtmlSingle'
  13. [docbookHtml, docbookFoPdf, docbookHtmlSingle]*.sourceFileName = 'faq.xml'
  14. docbookHtmlSingle.suffix = ''
  15. spec = copySpec {
  16. into ('faq') {
  17. from("$buildDir/docs")
  18. from("$projectDir/src/resources")
  19. }
  20. }
  21. }
  22. project('manual') {
  23. defaultTasks 'docbookHtml', 'docbookHtmlSingle', 'docbookFoPdf'
  24. [docbookHtml, docbookFoPdf, docbookHtmlSingle]*.sourceFileName = 'springsecurity.xml'
  25. docbookHtml.stylesheet = new File(projectDir, 'src/xsl/html-custom.xsl')
  26. docbookHtmlSingle.stylesheet = new File(projectDir, 'src/xsl/html-single-custom.xsl')
  27. docbookFoPdf.stylesheet = new File(projectDir, 'src/xsl/pdf-custom.xsl')
  28. def imagesDir = new File(projectDir, 'src/docbook/images');
  29. // docbookFoPdf.admonGraphicsPath = "${imagesDir}/"
  30. docbookFoPdf.imgSrcPath = "${projectDir}/src/docbook/"
  31. spec = copySpec {
  32. into ('reference') {
  33. from("$buildDir/docs")
  34. from("$projectDir/src/resources")
  35. }
  36. into ('reference/images') {
  37. from (imagesDir)
  38. }
  39. }
  40. }
  41. task apidocs(type: Javadoc) {
  42. destinationDir = new File(buildDir, 'apidocs')
  43. title = "Spring Security $version API"
  44. optionsFile = file("$buildDir/tmp/javadoc.options")
  45. source coreModuleProjects.collect { project ->
  46. project.sourceSets.main.allJava
  47. }
  48. classpath = files(coreModuleProjects.collect { project ->
  49. project.sourceSets.main.compileClasspath
  50. })
  51. }
  52. apiSpec = copySpec {
  53. into('apidocs') {
  54. from(apidocs.destinationDir)
  55. }
  56. }
  57. task docSiteLogin(type: Login) {
  58. if (project.hasProperty('sshHost')) {
  59. host = project.property('sshHost')
  60. }
  61. }
  62. // Define remoteSiteDir and sshHost in gradle.properties
  63. def remoteDocsDir = null
  64. if (hasProperty('remoteSiteDir')) {
  65. remoteDocsDir="$remoteSiteDir/docs/3.1.x"
  66. }
  67. task uploadApidocs(type: TarUpload) {
  68. dependsOn apidocs
  69. baseName = "${rootProject.name}"
  70. appendix = 'apidocs'
  71. remoteDir = remoteDocsDir
  72. login = docSiteLogin
  73. with(apiSpec)
  74. }
  75. task uploadManual(type: TarUpload) {
  76. dependsOn 'manual:docbook'
  77. baseName = "${rootProject.name}"
  78. appendix = 'doc'
  79. remoteDir = remoteDocsDir
  80. login = docSiteLogin
  81. with(project('manual').spec)
  82. }
  83. task uploadFaq(type: TarUpload) {
  84. dependsOn 'faq:docbookHtmlSingle'
  85. baseName = "${rootProject.name}"
  86. appendix = 'faq'
  87. if (project.hasProperty('remoteSiteDir')) {
  88. remoteDir = project.property('remoteSiteDir')
  89. }
  90. login = docSiteLogin
  91. with(project('faq').spec)
  92. }
  93. assemble.dependsOn = [apidocs, 'manual:docbook']