eff9cae314
Add global language switch capabilities to the refdoc
...
See gh-21778
2019-08-13 16:29:47 +02:00
96658235c8
Add Kotlin code snippets to core refdoc
...
This commit introduces Kotlin code snippets, for now
in the core reference documentation. Other sections
will follow, as well as improvements like global
language switch.
See gh-21778
2019-08-12 15:45:18 +02:00
8ca834b868
Merge branch '5.1.x'
2019-07-09 18:24:03 +02:00
99758b56d3
Ensure Javadoc is generated using UTF-8 encoding
...
Fixes gh-23253
2019-07-09 18:22:11 +02:00
cd0b517abf
Improve Kotlin documentation
2019-04-09 12:28:00 +02:00
9ca70dc1d3
URL Cleanup
...
This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener).
# Fixed URLs
## Fixed But Review Recommended
These URLs were fixed, but the https status was not OK. However, the https status was the same as the http request or http redirected to an https URL, so they were migrated. Your review is recommended.
* http://quartz-scheduler.org/api/2.2.1/ (301) migrated to:
https://www.quartz-scheduler.org/api/2.2.1/ ([https](https://quartz-scheduler.org/api/2.2.1/ ) result 404).
## Fixed Success
These URLs were fixed successfully.
* http://docs.jboss.org/jbossas/javadoc/4.0.5/connector/ migrated to:
https://docs.jboss.org/jbossas/javadoc/4.0.5/connector/ ([https](https://docs.jboss.org/jbossas/javadoc/4.0.5/connector/ ) result 200).
* http://docs.jboss.org/jbossas/javadoc/7.1.2.Final/ migrated to:
https://docs.jboss.org/jbossas/javadoc/7.1.2.Final/ ([https](https://docs.jboss.org/jbossas/javadoc/7.1.2.Final/ ) result 200).
* http://docs.oracle.com/cd/E13222_01/wls/docs90/javadocs/ migrated to:
https://docs.oracle.com/cd/E13222_01/wls/docs90/javadocs/ ([https](https://docs.oracle.com/cd/E13222_01/wls/docs90/javadocs/ ) result 200).
* http://docs.oracle.com/javaee/7/api/ migrated to:
https://docs.oracle.com/javaee/7/api/ ([https](https://docs.oracle.com/javaee/7/api/ ) result 200).
* http://docs.oracle.com/javase/8/docs/api/ migrated to:
https://docs.oracle.com/javase/8/docs/api/ ([https](https://docs.oracle.com/javase/8/docs/api/ ) result 200).
* http://fasterxml.github.io/jackson-core/javadoc/2.9/ migrated to:
https://fasterxml.github.io/jackson-core/javadoc/2.9/ ([https](https://fasterxml.github.io/jackson-core/javadoc/2.9/ ) result 200).
* http://fasterxml.github.io/jackson-databind/javadoc/2.9/ migrated to:
https://fasterxml.github.io/jackson-databind/javadoc/2.9/ ([https](https://fasterxml.github.io/jackson-databind/javadoc/2.9/ ) result 200).
* http://fasterxml.github.io/jackson-dataformat-xml/javadoc/2.9/ migrated to:
https://fasterxml.github.io/jackson-dataformat-xml/javadoc/2.9/ ([https](https://fasterxml.github.io/jackson-dataformat-xml/javadoc/2.9/ ) result 200).
* http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/ migrated to:
https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/ ([https](https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/ ) result 200).
* http://issues.gradle.org/browse/GRADLE-1116 migrated to:
https://issues.gradle.org/browse/GRADLE-1116 ([https](https://issues.gradle.org/browse/GRADLE-1116 ) result 200).
* http://projectreactor.io/docs/core/release/api/ migrated to:
https://projectreactor.io/docs/core/release/api/ ([https](https://projectreactor.io/docs/core/release/api/ ) result 200).
* http://tiles.apache.org/framework/apidocs/ migrated to:
https://tiles.apache.org/framework/apidocs/ ([https](https://tiles.apache.org/framework/apidocs/ ) result 200).
* http://tiles.apache.org/tiles-request/apidocs/ migrated to:
https://tiles.apache.org/tiles-request/apidocs/ ([https](https://tiles.apache.org/tiles-request/apidocs/ ) result 200).
* http://www.apache.org/licenses/LICENSE-2.0 migrated to:
https://www.apache.org/licenses/LICENSE-2.0 ([https](https://www.apache.org/licenses/LICENSE-2.0 ) result 200).
* http://www.eclipse.org/aspectj/doc/released/aspectj5rt-api/ migrated to:
https://www.eclipse.org/aspectj/doc/released/aspectj5rt-api/ ([https](https://www.eclipse.org/aspectj/doc/released/aspectj5rt-api/ ) result 200).
* http://www.reactive-streams.org/reactive-streams-1.0.1-javadoc/ migrated to:
https://www.reactive-streams.org/reactive-streams-1.0.1-javadoc/ ([https](https://www.reactive-streams.org/reactive-streams-1.0.1-javadoc/ ) result 200).
* http://docs.spring.io/spring-framework/docs migrated to:
https://docs.spring.io/spring-framework/docs ([https](https://docs.spring.io/spring-framework/docs ) result 301).
* http://glassfish.java.net/nonav/docs/v3/api/ migrated to:
https://glassfish.java.net/nonav/docs/v3/api/ ([https](https://glassfish.java.net/nonav/docs/v3/api/ ) result 301).
* http://pic.dhe.ibm.com/infocenter/wasinfo/v7r0/topic/com.ibm.websphere.javadoc.doc/web/apidocs/ migrated to:
https://pic.dhe.ibm.com/infocenter/wasinfo/v7r0/topic/com.ibm.websphere.javadoc.doc/web/apidocs/ ([https](https://pic.dhe.ibm.com/infocenter/wasinfo/v7r0/topic/com.ibm.websphere.javadoc.doc/web/apidocs/ ) result 301).
* http://projects.spring.io/spring-framework migrated to:
https://projects.spring.io/spring-framework ([https](https://projects.spring.io/spring-framework ) result 301).
* http://springframework.org/schema migrated to:
https://springframework.org/schema ([https](https://springframework.org/schema ) result 301).
* http://ehcache.org/apidocs/2.10.4 (301) migrated to:
https://www.ehcache.org/apidocs/2.10.4 ([https](https://ehcache.org/apidocs/2.10.4 ) result 301).
2019-03-12 17:50:04 +01:00
5938742afd
URL Cleanup ( #22515 )
...
This commit updates URLs to prefer the https protocol. Redirects are not followed to avoid accidentally expanding intentionally shortened URLs (i.e. if using a URL shortener).
# Fixed URLs
## Fixed Success
These URLs were fixed successfully.
* http://docs.jboss.org/jbossas/javadoc/4.0.5/connector/ migrated to:
https://docs.jboss.org/jbossas/javadoc/4.0.5/connector/ ([https](https://docs.jboss.org/jbossas/javadoc/4.0.5/connector/ ) result 200).
* http://docs.jboss.org/jbossas/javadoc/7.1.2.Final/ migrated to:
https://docs.jboss.org/jbossas/javadoc/7.1.2.Final/ ([https](https://docs.jboss.org/jbossas/javadoc/7.1.2.Final/ ) result 200).
* http://docs.oracle.com/javaee/7/api/ migrated to:
https://docs.oracle.com/javaee/7/api/ ([https](https://docs.oracle.com/javaee/7/api/ ) result 200).
* http://docs.oracle.com/javase/8/docs/api/ migrated to:
https://docs.oracle.com/javase/8/docs/api/ ([https](https://docs.oracle.com/javase/8/docs/api/ ) result 200).
* http://fasterxml.github.io/jackson-core/javadoc/2.9/ migrated to:
https://fasterxml.github.io/jackson-core/javadoc/2.9/ ([https](https://fasterxml.github.io/jackson-core/javadoc/2.9/ ) result 200).
* http://fasterxml.github.io/jackson-databind/javadoc/2.9/ migrated to:
https://fasterxml.github.io/jackson-databind/javadoc/2.9/ ([https](https://fasterxml.github.io/jackson-databind/javadoc/2.9/ ) result 200).
* http://fasterxml.github.io/jackson-dataformat-xml/javadoc/2.9/ migrated to:
https://fasterxml.github.io/jackson-dataformat-xml/javadoc/2.9/ ([https](https://fasterxml.github.io/jackson-dataformat-xml/javadoc/2.9/ ) result 200).
* http://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/ migrated to:
https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/ ([https](https://hc.apache.org/httpcomponents-client-ga/httpclient/apidocs/ ) result 200).
* http://issues.gradle.org/browse/GRADLE-1116 migrated to:
https://issues.gradle.org/browse/GRADLE-1116 ([https](https://issues.gradle.org/browse/GRADLE-1116 ) result 200).
* http://projectreactor.io/docs/core/release/api/ migrated to:
https://projectreactor.io/docs/core/release/api/ ([https](https://projectreactor.io/docs/core/release/api/ ) result 200).
* http://tiles.apache.org/framework/apidocs/ migrated to:
https://tiles.apache.org/framework/apidocs/ ([https](https://tiles.apache.org/framework/apidocs/ ) result 200).
* http://tiles.apache.org/tiles-request/apidocs/ migrated to:
https://tiles.apache.org/tiles-request/apidocs/ ([https](https://tiles.apache.org/tiles-request/apidocs/ ) result 200).
* http://www.apache.org/licenses/LICENSE-2.0 migrated to:
https://www.apache.org/licenses/LICENSE-2.0 ([https](https://www.apache.org/licenses/LICENSE-2.0 ) result 200).
* http://www.eclipse.org/aspectj/doc/released/aspectj5rt-api/ migrated to:
https://www.eclipse.org/aspectj/doc/released/aspectj5rt-api/ ([https](https://www.eclipse.org/aspectj/doc/released/aspectj5rt-api/ ) result 200).
* http://www.reactive-streams.org/reactive-streams-1.0.1-javadoc/ migrated to:
https://www.reactive-streams.org/reactive-streams-1.0.1-javadoc/ ([https](https://www.reactive-streams.org/reactive-streams-1.0.1-javadoc/ ) result 200).
* http://docs.spring.io/spring-framework/docs migrated to:
https://docs.spring.io/spring-framework/docs ([https](https://docs.spring.io/spring-framework/docs ) result 301).
* http://glassfish.java.net/nonav/docs/v3/api/ migrated to:
https://glassfish.java.net/nonav/docs/v3/api/ ([https](https://glassfish.java.net/nonav/docs/v3/api/ ) result 301).
* http://projects.spring.io/spring-framework migrated to:
https://projects.spring.io/spring-framework ([https](https://projects.spring.io/spring-framework ) result 301).
* http://springframework.org/schema migrated to:
https://springframework.org/schema ([https](https://springframework.org/schema ) result 301).
* http://ehcache.org/apidocs/2.10.4 (301) migrated to:
https://www.ehcache.org/apidocs/2.10.4 ([https](https://ehcache.org/apidocs/2.10.4 ) result 301).
2019-03-05 23:21:36 +01:00
8c768e48fa
Use Spring Doc Resources for reference docs
...
This commit removes the custom static resources for the reference
documentation and instead uses the new Spring Doc Resources project
https://github.com/spring-io/spring-doc-resources
The asciidoctor theme is now shared between Spring projects and
integrated in the project build.
2019-01-09 18:38:31 +01:00
abc68ef8ea
Revert "package list URL for Reactor javadoc in Dokka"
...
This reverts commit dc2535516c
2019-01-08 10:31:00 +01:00
dc2535516c
Fix package list URL for Reactor javadoc in Dokka
...
Reactor is now building its Javadoc with a recent JDK version, which
changes the structure of the published HTML pages.
Without this change, the build fails during the Dokka generation with
the following exception:
```
Exception while loading package-list from
ExternalDocumentationLinkImpl(
url=http://projectreactor.io/docs/core/release/api/ ,
packageListUrl=http://projectreactor.io/docs/core/release/api/package-list )
```
This commit now points to the `/element-list` page, which seems to
contain the same information as the `package-list` page.
2019-01-07 20:53:56 +01:00
13c090b41d
Generate “Use” links in aggregated Spring API JavaDoc
...
This commit enables the `-use` javadoc flag so that class usage pages
are included in the aggregated JavaDoc that is published to
https://docs.spring.io/spring-framework/docs/ .
Issue: SPR-17173
2018-08-13 11:56:18 +02:00
da6e9c6d54
Restore layout of docs zip with index.html at the top
...
Issue: SPR-16799
2018-05-09 17:29:04 -04:00
cdf483fd50
Task "docsZip" copies duplicate reference files
...
Specify task "docsZip" source directory.
Issue: SPR-16789
2018-05-03 16:36:42 -04:00
c7c743872a
Fix Dokka reference to Spring Framework's Javadoc
...
This commit specifies a local packageListUrl and defines that dokka task
must be executed after the api task in order to be able to build KDoc
during the release process when the Spring Framework's Javadoc is not
published yet.
Issue: SPR-16687
2018-04-04 11:08:05 +02:00
3fb8d16ff7
Temporarily remove reference to Spring Framework's Javadoc
...
Issue: SPR-16687
2018-04-03 21:14:49 +02:00
769ea1b106
Fix Kdoc regression to show only Kotlin API
...
As of Gradle Kotlin plugin 1.1.60,
project.sourceSets.main.kotlin.srcDirs contains
Java source directories in addition to Kotlin
ones. This commit filter out Java sources to
retain only Kotlin ones.
Issue: SPR-16268
2017-12-11 11:28:39 +01:00
2e0a2845ab
Top-level main.css for all asciidoctor styles
...
Properly separate tocbot from asciidoctor styles and use main.css to
include both.
2017-10-11 07:40:25 -04:00
ee3913c6d0
Use Tocbot for Table of Contents
2017-10-05 22:23:38 -04:00
9190b76ab9
Latest dependency updates (POI 3.17, Rome 1.8, EhCache 3.4, Caffeine 2.5.6, RxJava 2.1.4, Tomcat 8.5.21, JRuby 9.1.13, Rhino 1.7.7.2)
2017-09-23 11:28:19 +02:00
ed6a35b465
Add API and reference documentation for Kotlin support
...
Issue: SPR-15659
2017-08-29 01:07:27 +02:00
9341955107
Do not render PDF reference doc for SNAPSHOT builds
...
This commit ensures that only the HTML version of the reference
documentation is rendered for SNAPSHOT builds. This speeds up
significatly the build.
Issue: SPR-15885
2017-08-21 14:42:21 +02:00
0c178ff762
Generate docs *after* running tests in Gradle build
...
This commit reorders docs generation (javadoc, asciidoctor) *after*
runing tests for `./gradlew build` commands.
Issue: SPR-15885
2017-08-21 14:41:38 +02:00
2e50ea7eb4
Move plugin declarations to plugin syntax
...
Note: this syntax automatically applies the plugin to the root project.
Adding `apply false` in the plugin declaration disables that.
Issue: SPR-15885
2017-08-21 14:41:28 +02:00
3a4b205b20
Use Rouge syntax highlighting in PDF version of Reference Manual
...
This commit uses a tip provided by @mojavelinux to set the syntax
highlighter to Rouge for the PDF version of the User Guide.
Once Asciidoctor 1.5.7 has been released we will likely switch to Rouge
for the HTML version of the Reference Manual as well.
Issue: SPR-14997
2017-04-06 18:07:19 +02:00
924adaec6c
Render reference documentation with Asciidoctor
...
This commit removes docbook from the documentation toolchain and
instead makes use of asciidoctor to render the reference documentation
in HTML and PDF formats.
The main Gradle build has been refactored with the documentation tasks
and sniffer tasks extracted to their own gradle file in the "gradle"
folder.
A new asciidoctor Spring theme is also used to render the HTML5 backend.
Issue: SPR-14997
2017-03-29 14:22:46 +02:00
Sebastien Deleuze
Sam Brannen
Spring Operator
Spring Operator
Brian Clozel
Sam Brannen
Rossen Stoyanchev
nkjackzhang
Stephane Nicoll
Juergen Hoeller