Commit Graph

174 Commits

Author SHA1 Message Date
Simon Baslé
eabb846d07 Improve how the build deals with javadoc invalid references
This commit improves how the build deals with javadoc invalid references
in two ways.

Link/see references that are temporarily invalid during javadoc
generation of individual modules are better masked by using the option
`Xdoclint:syntax` instead of `Xdoclint:none` (warnings were still
visible in some cases, e.g. when individually building the javadoc for
a specific module).

Global javadoc-building task `api` now combines `syntax` and `reference`
`Xdoclint` groups, allowing to raise truly invalid references even when
all the modules have been aggregated.

This commit also fixes the 20+ errors which appeared following the later
change in doclet configuration.

Closes gh-30428
2023-05-16 15:04:10 +02:00
Jan Mewes
280b0de646 Docs: Remove duplicate in SpEL feature list
Closes gh-30404
2023-05-15 15:22:44 +02:00
Sam Brannen
2738b3e50f Polishing
See gh-30482
2023-05-15 15:09:06 +02:00
Anyuruf
169795d673 Fix wording in r2dbc Statement Filters section of ref docs
Co-authored-by: Sam Brannen <sam@sambrannen.com>
Closes gh-30482
2023-05-15 15:08:58 +02:00
rstoyanchev
806519f78a Comment out check->antora dependency
See gh-30481
2023-05-12 10:19:52 +01:00
Stephane Nicoll
a9b94241af Fix typo
Closes gh-30473
2023-05-11 16:35:20 +02:00
Rob Winch
d8f6567c89 Download the playbook to build dir
Closes gh-30465
2023-05-10 17:39:40 +01:00
Stephane Nicoll
93fa01004c Document AOT best practices
This commit augment the AOT section with best practices we have
experienced while working on the AOT engine. In particular, it describes
how a FactoryBean with an unresolved generic should be handled.

Closes gh-30434
2023-05-09 16:25:36 +02:00
Arjen Poutsma
a133aae8d6 Document @ResponseStatus behavior
This commit documents that the ResponseStatus annotation does not
override the status set through other means.

Closes gh-30305
See gh-18019
2023-05-09 14:01:33 +02:00
Rob Winch
3a0a19cff8 Fix migration to asciidoctor tabs
The automation to asciidoctor tabs did not migrate properly for all
cases this commit fixes the migration.

See gh-30435
2023-05-09 12:15:43 +01:00
Rob Winch
06f16f15ed Remove PDF Link
See gh-30430
2023-05-05 16:56:25 +01:00
rstoyanchev
8a8fb31f4a Update target repository for Antora
See gh-30414
2023-05-04 15:37:21 +01:00
Rob Winch
719553f627 Fix Web Reactive link on the landing page 2023-05-04 15:35:05 +01:00
Rob Winch
993447deb0 Remove invalid deploy-docs.yml 2023-05-04 15:35:05 +01:00
Rob Winch
88c9b0f467 Use the shared antora playbook 2023-05-04 15:35:05 +01:00
Rob Winch
39146f9066 Migrate to Asciidoctor Tabs 2023-05-04 15:35:05 +01:00
Rob Winch
7b0ba0188f Structural Fixes 2023-05-04 15:35:05 +01:00
Rob Winch
3774e9be7a Trim IDs with parent 2023-05-04 15:35:05 +01:00
Rob Winch
9c38f8c3c6 Make local build (temporary) 2023-05-04 15:35:05 +01:00
Rob Winch
26171d9efb Fix Title in antora.yml 2023-05-04 15:35:05 +01:00
Rob Winch
68235464fc Use include-code Macro 2023-05-04 15:35:05 +01:00
Rob Winch
51ada4e19d Fix invalid nav elements 2023-05-04 15:35:05 +01:00
Rob Winch
1a8e0031fe Fix index Overview link 2023-05-04 15:35:05 +01:00
Rob Winch
d8bcbd53e1 Fix invalid attributes 2023-05-04 15:35:05 +01:00
Rob Winch
6993a9eee4 fix antora.yml attributes 2023-05-04 15:35:05 +01:00
Rob Winch
d2720741a5 Fix antora.yml gradle command 2023-05-04 15:35:05 +01:00
Rob Winch
067e6c2a9e fix framework-docs.gradle 2023-05-04 15:35:05 +01:00
Rob Winch
35229c8bff Enable Section Summary TOC for small pages 2023-05-04 15:35:05 +01:00
Rob Winch
139cde47e2 Fix cross references 2023-05-04 15:35:05 +01:00
Rob Winch
6b341ddf19 Remove includes 2023-05-04 15:35:05 +01:00
Rob Winch
5aecfb1878 Generate a default navigation 2023-05-04 15:35:05 +01:00
Rob Winch
9f49d24833 Split files 2023-05-04 15:35:05 +01:00
Rob Winch
ac69a5dac3 Copy default antora files 2023-05-04 15:35:05 +01:00
Rob Winch
7f9061a3cb Fix image::image 2023-05-04 15:35:05 +01:00
Rob Winch
a05ff6c126 Remove unnecessary asciidoc attributes 2023-05-04 15:35:05 +01:00
Rob Winch
9ceb75b228 Insert explicit ids for headers 2023-05-04 15:35:05 +01:00
Rob Winch
3fe7c65218 Migrate Structure 2023-05-04 15:35:05 +01:00
Rob Winch
a78836c18b Remove duplicated testing from .adoc file path 2023-05-04 15:35:05 +01:00
Rob Winch
2a4a1cc550 Remove -languages suffix from .adoc files 2023-05-04 15:35:05 +01:00
Rob Winch
c762c07290 Remove integration- prefix from .adoc files 2023-05-04 15:35:05 +01:00
Rob Winch
957467aa32 Remove data-access- prefix from .adoc files 2023-05-04 15:35:04 +01:00
Rob Winch
49a4734cfa Remove core- prefix from .adoc files 2023-05-04 15:35:04 +01:00
Filip Blondeel
8b9d2e3f95 Fix incorrect jakarta.inject artifact version
Closes gh-30270
2023-04-03 09:36:22 +02:00
1993heqiang
2b427efe7f Fix PathVariable reference documentation code snippets
Closes gh-30243
2023-03-31 15:51:56 +02:00
Juergen Hoeller
b2be07c73c Polishing 2023-03-28 13:26:29 +02:00
Ed .d
50d01ce405 feat: Add support for Vavr's Try monad to trigger transaction rollbacks
Updated the Spring Framework documentation to include an example of using Vavr's Try monad to trigger transaction rollbacks when a @Transactional-annotated method returns a Failure. The modified documentation demonstrates how to use Try in a transactional method and how to check if an exception has been wrapped inside a Try.Failure instance. Additionally, a link to the official Vavr documentation was added to provide more information on the Try method.
2023-03-28 10:38:03 +02:00
heqiang
ec270c7135 Use diamond operator in examples in reference manual
Closes gh-30204
2023-03-27 18:27:29 +02:00
Kukri
570d21ebbd Fix anchor in link to "Web on Reactive Stack" chapter
Closes gh-30158
2023-03-22 11:30:35 +01:00
Brian Clozel
3af8efbdc7 Add anchor rewrites in the reference documentation
This commit adds an `anchor-rewrite.properties` file in the reference
documentation sources. This allows to redirect from one anchor to
another when they are renamed.

This also populates the file with anchors that were renamed in the AOT
section of the documentation.

Closes gh-30132
2023-03-17 17:28:12 +01:00
Brian Clozel
2e08a07d7c Add a list of produced observations
This commit adds a list observations produced by Spring Framework in the
reference documentation.

Closes gh-30060
2023-03-17 17:27:11 +01:00