Skip to content

Commit bb3abbf

Browse files
committed
not done yet. trying to substitute reference.conf
1 parent 6cba250 commit bb3abbf

File tree

4 files changed

+2416
-36
lines changed

4 files changed

+2416
-36
lines changed

build-doc.sh

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,17 @@ mvn clean install -DskipTests # or guava-shaded can not be found
1212
# mvn javadoc:javadoc -pl core,query-builder,mapper-runtime
1313
mvn javadoc:aggregate
1414

15+
# Substitute the reference.yaml. I didn't find a better alternative.
16+
sed -i '' "/<SUBSTITUE_ME>/{
17+
r core/src/main/resources/reference.conf
18+
d
19+
}" manual/core/configuration/reference/README.md
20+
1521
# Build manual with API references
16-
mkdocs build # or `mkdocs serve` to preview
22+
mkdocs build # or `mkdocs serve` to preview
23+
24+
# revert the substitution
25+
sed -i '' "/{
26+
r core/src/main/resources/reference.conf
27+
d
28+
}/<SUBSTITUE_ME>" manual/core/configuration/reference/README.md

manual/core/configuration/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -552,6 +552,6 @@ config.getDefaultProfile().getInt(MyCustomOption.AWESOMENESS_FACTOR);
552552

553553
[Typesafe Config]: https://github.com/typesafehub/config
554554
[config standard behavior]: https://github.com/typesafehub/config#standard-behavior
555-
[reference.conf]: reference/
555+
[reference.conf]: ./reference.conf
556556
[HOCON]: https://github.com/typesafehub/config/blob/master/HOCON.md
557557
[API conventions]: ../../api_conventions

0 commit comments

Comments
 (0)