Merge pull request #138 from prgrms-be-devcourse/HIMIN-229-index-docs…

…-gonmoseull [HIMIN-229] feat : restdocs html 생성
prgrms-be-devcourse · Sep 25, 2023 · 8bd16a5 · 8bd16a5
2 parents 0e36715 + d58aaf1
commit 8bd16a5
Show file tree

Hide file tree

Showing 25 changed files with 13,694 additions and 15 deletions.
diff --git a/BOOT-INF/classes/static/docs/delivery.html b/BOOT-INF/classes/static/docs/delivery.html
diff --git a/BOOT-INF/classes/static/docs/index.html b/BOOT-INF/classes/static/docs/index.html
diff --git a/BOOT-INF/classes/static/docs/member.html b/BOOT-INF/classes/static/docs/member.html
diff --git a/BOOT-INF/classes/static/docs/menu.html b/BOOT-INF/classes/static/docs/menu.html
diff --git a/BOOT-INF/classes/static/docs/menuOption.html b/BOOT-INF/classes/static/docs/menuOption.html
diff --git a/BOOT-INF/classes/static/docs/menuOptionGroup.html b/BOOT-INF/classes/static/docs/menuOptionGroup.html
diff --git a/BOOT-INF/classes/static/docs/order.html b/BOOT-INF/classes/static/docs/order.html
diff --git a/BOOT-INF/classes/static/docs/shop.html b/BOOT-INF/classes/static/docs/shop.html
diff --git a/build.gradle b/build.gradle
@@ -19,13 +19,6 @@ configurations {
     asciidoctorExt
 }
 
-bootJar {
-    dependsOn asciidoctor
-    from("${asciidoctor.outputDir}/html5") {
-        into 'static/docs'
-    }
-}
-
 repositories {
     mavenCentral()
 }
@@ -73,6 +66,24 @@ asciidoctor {
     dependsOn test
 }
 
+bootJar {
+    dependsOn asciidoctor
+    copy {
+        from "${asciidoctor.outputDir}"
+        into 'BOOT-INF/classes/static/docs'
+    }
+}
+
+task copyDocument(type: Copy) {
+    dependsOn asciidoctor
+    from file("build/docs/asciidoc")
+    into file("src/main/resources/static/docs")
+}
+
+build {
+    dependsOn copyDocument
+}
+
 // Querydsl 추가, 자동 생성된 Q클래스 gradle clean으로 제거
 clean {
     delete file('src/main/generated')

diff --git a/src/docs/delivery.adoc → src/docs/asciidoc/delivery.adoc b/src/docs/delivery.adoc → src/docs/asciidoc/delivery.adoc
@@ -1,8 +1,7 @@
 :hardbreaks:
 ifndef::snippets[]
-:snippets: ../../../target/generated-snippets
+:snippets: ../../../build/generated-snippets
 endif::[]
-
 == 배달기사
 
 === 배달기사 생성

diff --git a/src/docs/asciidoc/index.adoc b/src/docs/asciidoc/index.adoc
@@ -0,0 +1,17 @@
+= 히히의 민환족 API 명세
+:doctype: book
+:icons: font
+:source-highlighter: highlightjs // 코드들의 하이라이팅을 highlightjs를 사용
+:toc: left // Table Of Contents(목차)를 문서의 좌측에 두기
+:toclevels: 2 // 목차 레벨 설정
+:sectlinks:
+:sectnums: // 분류별 자동으로 숫자를 달아줌
+:docinfo: shared-head
+
+include::delivery.adoc[]
+include::member.adoc[]
+include::menu.adoc[]
+include::menuOptionGroup.adoc[]
+include::menuOption.adoc[]
+include::order.adoc[]
+include::shop.adoc[]
diff --git a/src/docs/member.adoc → src/docs/asciidoc/member.adoc b/src/docs/member.adoc → src/docs/asciidoc/member.adoc
@@ -1,6 +1,6 @@
 :hardbreaks:
 ifndef::snippets[]
-:snippets: ../../../target/generated-snippets
+:snippets: ./build/generated-snippets
 endif::[]
 
 == 회원

diff --git a/src/docs/menu.adoc → src/docs/asciidoc/menu.adoc b/src/docs/menu.adoc → src/docs/asciidoc/menu.adoc
@@ -1,6 +1,6 @@
 :hardbreaks:
 ifndef::snippets[]
-:snippets: ../../../target/generated-snippets
+:snippets: ./build/generated-snippets
 endif::[]
 
 == 메뉴

diff --git a/src/docs/menuOption.adoc → src/docs/asciidoc/menuOption.adoc b/src/docs/menuOption.adoc → src/docs/asciidoc/menuOption.adoc
@@ -1,6 +1,6 @@
 :hardbreaks:
 ifndef::snippets[]
-:snippets: ../../../target/generated-snippets
+:snippets: ./build/generated-snippets
 endif::[]
 
 == 메뉴옵션

diff --git a/src/docs/menuOptionGroup.adoc → src/docs/asciidoc/menuOptionGroup.adoc b/src/docs/menuOptionGroup.adoc → src/docs/asciidoc/menuOptionGroup.adoc
@@ -1,6 +1,6 @@
 :hardbreaks:
 ifndef::snippets[]
-:snippets: ../../../target/generated-snippets
+:snippets: ./build/generated-snippets
 endif::[]
 
 == 메뉴옵션그룹

diff --git a/src/docs/order.adoc → src/docs/asciidoc/order.adoc b/src/docs/order.adoc → src/docs/asciidoc/order.adoc
@@ -1,6 +1,6 @@
 :hardbreaks:
 ifndef::snippets[]
-:snippets: ../../../target/generated-snippets
+:snippets: ./build/generated-snippets
 endif::[]
 
 == 주문

diff --git a/src/docs/shop.adoc → src/docs/asciidoc/shop.adoc b/src/docs/shop.adoc → src/docs/asciidoc/shop.adoc
@@ -1,6 +1,6 @@
 :hardbreaks:
 ifndef::snippets[]
-:snippets: ../../../target/generated-snippets
+:snippets: ./build/generated-snippets
 endif::[]
 
 == 가게

diff --git a/src/main/resources/static/docs/delivery.html b/src/main/resources/static/docs/delivery.html
diff --git a/src/main/resources/static/docs/index.html b/src/main/resources/static/docs/index.html
diff --git a/src/main/resources/static/docs/member.html b/src/main/resources/static/docs/member.html
diff --git a/src/main/resources/static/docs/menu.html b/src/main/resources/static/docs/menu.html
diff --git a/src/main/resources/static/docs/menuOption.html b/src/main/resources/static/docs/menuOption.html
diff --git a/src/main/resources/static/docs/menuOptionGroup.html b/src/main/resources/static/docs/menuOptionGroup.html
diff --git a/src/main/resources/static/docs/order.html b/src/main/resources/static/docs/order.html
diff --git a/src/main/resources/static/docs/shop.html b/src/main/resources/static/docs/shop.html