docs.gradle 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. // Docbook and Javadoc building and uploading tasks
  2. apply plugin: 'base'
  3. task docs {
  4. dependsOn 'manual:asciidoctor', 'apidocs', 'guides:asciidoctor'
  5. }
  6. project('manual') {
  7. apply plugin: 'base'
  8. apply plugin: 'asciidoctor'
  9. ext.expandPlaceholders = ""
  10. asciidoctor {
  11. backends = ["html5", "pdf"]
  12. options = [
  13. eruby: 'erubis',
  14. attributes: [
  15. copycss : '',
  16. icons : 'font',
  17. 'source-highlighter': 'prettify',
  18. sectanchors : '',
  19. toc2: '',
  20. idprefix: '',
  21. idseparator: '-',
  22. doctype: 'book',
  23. numbered: '',
  24. 'spring-security-version' : project.version,
  25. revnumber : project.version
  26. ]
  27. ]
  28. }
  29. ext.spec = copySpec {
  30. into ('reference/htmlsingle') {
  31. from("${asciidoctor.outputDir}/dist/html5")
  32. }
  33. into ('reference/pdf') {
  34. from("${asciidoctor.outputDir}/dist/pdf")
  35. }
  36. }
  37. }
  38. task apidocs(type: Javadoc) {
  39. destinationDir = new File(buildDir, 'apidocs')
  40. title = "Spring Security $version API"
  41. source coreModuleProjects.collect { project ->
  42. project.sourceSets.main.allJava
  43. }
  44. classpath = files(coreModuleProjects.collect { project ->
  45. project.sourceSets.main.compileClasspath
  46. })
  47. }
  48. apidocs.options.outputLevel = org.gradle.external.javadoc.JavadocOutputLevel.QUIET
  49. apidocs.options.links = [
  50. "http://static.springframework.org/spring/docs/3.2.x/javadoc-api",
  51. "http://static.springsource.org/spring-ldap/docs/1.3.x/apidocs/",
  52. "http://download.oracle.com/javase/6/docs/api/"
  53. ]
  54. apidocs.options.groups = [
  55. 'Spring Security Core':[
  56. 'org.springframework.security.core*',
  57. 'org.springframework.security.authentication*',
  58. 'org.springframework.security.access*',
  59. 'org.springframework.security.remoting*',
  60. 'org.springframework.security.provisioning*',
  61. 'org.springframework.security.util*'],
  62. 'Spring Security Web':['org.springframework.security.web*'],
  63. 'Spring Security LDAP':['org.springframework.security.ldap*'],
  64. 'Spring Security Crypto':['org.springframework.security.crypto*'],
  65. 'Spring Security OpenID':['org.springframework.security.openid*'],
  66. 'Spring Security CAS':['org.springframework.security.cas*'],
  67. 'Spring Security ACL':['org.springframework.security.acls*'],
  68. 'Spring Security Config':['org.springframework.security.config*'],
  69. 'Spring Security Taglibs':['org.springframework.security.taglibs*'],
  70. ]
  71. ext.apiSpec = copySpec {
  72. into('apidocs') {
  73. from(apidocs.destinationDir)
  74. }
  75. }
  76. assemble.dependsOn = [apidocs, 'manual:asciidoctor']
  77. task docsZip(type: Zip) {
  78. dependsOn docs
  79. evaluationDependsOn('guides')
  80. group = 'Distribution'
  81. baseName = rootProject.name
  82. classifier = 'docs'
  83. description = "Builds -${classifier} archive containing api and reference " +
  84. "for deployment at static.springframework.org/spring-security/site/docs."
  85. with(project(':docs').apiSpec)
  86. with(project(':docs:manual').spec)
  87. with(project(':docs:guides').spec)
  88. }
  89. task schemaZip(type: Zip) {
  90. group = 'Distribution'
  91. baseName = rootProject.name
  92. classifier = 'schema'
  93. description = "Builds -${classifier} archive containing all " +
  94. "XSDs for deployment at static.springframework.org/schema."
  95. coreModuleProjects.each { module ->
  96. def Properties schemas = new Properties();
  97. module.sourceSets.main.resources.find {
  98. it.path.endsWith('META-INF/spring.schemas')
  99. }?.withInputStream { schemas.load(it) }
  100. for (def key : schemas.keySet()) {
  101. def shortName = key.replaceAll(/http.*schema.(.*).spring-.*/, '$1')
  102. assert shortName != key
  103. File xsdFile = module.sourceSets.main.resources.find {
  104. it.path.endsWith(schemas.get(key))
  105. }
  106. assert xsdFile != null
  107. into (shortName) {
  108. from xsdFile.path
  109. }
  110. }
  111. }
  112. }