Skip to content

Commit b84b1b7

Browse files
committed
Update documentation generation
1 parent 24933b0 commit b84b1b7

File tree

7 files changed

+2
-57
lines changed

7 files changed

+2
-57
lines changed

spring-shell-docs/antora-playbook.yml

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
1-
# PACKAGES antora@3.2.0-alpha.2 @antora/atlas-extension:1.0.0-alpha.1 @antora/collector-extension@1.0.0-alpha.3 @springio/antora-extensions@1.1.0-alpha.2 @asciidoctor/tabs@1.0.0-alpha.12 @opendevise/antora-release-line-extension@1.0.0-alpha.2
2-
#
3-
# The purpose of this Antora playbook is to build the docs in the current branch.
41
antora:
52
extensions:
63
- require: '@springio/antora-extensions'
74
root_component_name: 'shell'
8-
- require: '@springio/antora-extensions/asciinema-extension'
95
site:
106
title: Spring Shell
117
url: https://docs.spring.io/spring-shell/reference/
@@ -25,7 +21,6 @@ asciidoc:
2521
extensions:
2622
- '@asciidoctor/tabs'
2723
- '@springio/asciidoctor-extensions'
28-
- '@springio/asciidoctor-extensions/javadoc-extension'
2924
sourcemap: true
3025
urls:
3126
latest_version_segment: ''

spring-shell-docs/antora.yml

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,9 @@ version: true
33
title: Spring Shell
44
nav:
55
- modules/ROOT/nav.adoc
6-
ext:
7-
collector:
8-
run:
9-
command: ./mvnw process-resources -pl spring-shell-docs -am
10-
scan:
11-
dir: ./target/classes/antora-resources
126

137
asciidoc:
148
attributes:
159
attribute-missing: 'warn'
16-
# FIXME: the copyright is not removed
17-
# FIXME: The package is not renamed
1810
chomp: 'all'
1911
snippets: example$docs-src/test/java/org/springframework/shell/docs

spring-shell-docs/modules/ROOT/examples/getting-started-run-interactive.out

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
$ $JAVA_HOME/bin/java -jar demo-0.0.1-SNAPSHOT.jar
22

3-
. ____ _ __ _ _
4-
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
5-
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
6-
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
7-
' |____| .__|_| |_|_| |_\__, | / / / /
8-
=========|_|==============|___/=/_/_/_/
9-
:: Spring Boot :: (v{spring-boot-version})
10-
113
2022-09-13T18:42:12.818+01:00 INFO 12644 --- [ main] com.example.demo.DemoApplication
124
: Starting DemoApplication using Java 17.0.4 on ...
135
2022-09-13T18:42:12.821+01:00 INFO 12644 --- [ main] com.example.demo.DemoApplication

spring-shell-docs/modules/ROOT/examples/getting-started-run-noninteractive.out

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,5 @@
11
$JAVA_HOME/bin/java -jar demo-0.0.1-SNAPSHOT.jar help
22

3-
. ____ _ __ _ _
4-
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
5-
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
6-
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
7-
' |____| .__|_| |_|_| |_\__, | / / / /
8-
=========|_|==============|___/=/_/_/_/
9-
:: Spring Boot :: (v{spring-boot-version})
10-
113
2022-09-13T18:42:12.818+01:00 INFO 12644 --- [ main] com.example.demo.DemoApplication
124
: Starting DemoApplication using Java 17.0.4 on ...
135
2022-09-13T18:42:12.821+01:00 INFO 12644 --- [ main] com.example.demo.DemoApplication

spring-shell-docs/modules/ROOT/pages/getting-started.adoc

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44
To see what Spring Shell has to offer, we can write a trivial _hello world_
55
shell application that has a simple argument.
66

7-
IMPORTANT: _Spring Shell_ is based on _Spring Boot_ {spring-boot-version} and
8-
_Spring Framework_ {spring-version} and thus requires _JDK 17_.
9-
107
[[creating-a-project]]
118
== Creating a Project
129

@@ -22,7 +19,7 @@ With _maven_ you're expected to have something like:
2219
[source, xml, subs=attributes+]
2320
----
2421
<properties>
25-
<spring-shell.version>{project-version}</spring-shell.version>
22+
<spring-shell.version>LATEST_VERSION</spring-shell.version>
2623
</properties>
2724
2825
<dependencies>
@@ -61,7 +58,7 @@ dependencies {
6158
6259
dependencyManagement {
6360
imports {
64-
mavenBom "org.springframework.shell:spring-shell-dependencies:{project-version}"
61+
mavenBom "org.springframework.shell:spring-shell-dependencies:LATEST_VERSION"
6562
}
6663
}
6764
----

spring-shell-docs/modules/ROOT/pages/index.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
Eric Bottard; Janne Valkealahti; Jay Bryant; Corneil du Plessis
33
:page-section-summary-toc: 1
44

5-
**{project-version}**
6-
75
Not all applications need a fancy web user interface. Sometimes, interacting with an application through an interactive terminal is the most appropriate way to get things done.
86

97
Spring Shell lets you create such a runnable application, where the user enters textual commands that are run until the program terminates. The Spring Shell project provides the infrastructure to create such a REPL (Read, Eval, Print Loop) application, letting you concentrate on implementing commands by using the familiar Spring programming model.

spring-shell-docs/pom.xml

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -55,28 +55,7 @@
5555
<artifactId>antora-maven-plugin</artifactId>
5656
<version>${io.spring.maven.antora-version}</version>
5757
<extensions>true</extensions>
58-
<configuration>
59-
<packages>
60-
<package>@antora/atlas-extension@1.0.0-alpha.2</package>
61-
<package>@antora/collector-extension@1.0.1</package>
62-
<package>@asciidoctor/tabs@1.0.0-beta.6</package>
63-
<package>@springio/asciidoctor-extensions@1.0.0-alpha.17</package>
64-
</packages>
65-
</configuration>
6658
</plugin>
67-
<plugin>
68-
<groupId>io.spring.maven.antora</groupId>
69-
<artifactId>antora-component-version-maven-plugin</artifactId>
70-
<version>${io.spring.maven.antora-version}</version>
71-
<executions>
72-
<execution>
73-
<goals>
74-
<goal>antora-component-version</goal>
75-
</goals>
76-
</execution>
77-
</executions>
78-
</plugin>
79-
8059
<plugin>
8160
<groupId>org.apache.maven.plugins</groupId>
8261
<artifactId>maven-deploy-plugin</artifactId>

0 commit comments

Comments
 (0)