docs.gradle 3.9 KB

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