sphinx docs

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [v2.7.0-SNAPSHOT] - 2022-07-27
+
+- Sphinx
+
 ## [v2.6.2] - 2022-07-27
 
 - Bug fix #23695 social service 2/people/profile api fails sometimes with error 500

enunciate.xml

@@ -26,7 +26,7 @@
 <!-- 			</package-conversions> -->
 <!-- 		</java-json-client> -->
 		<javascript-client disabled="true" />
-		<docs docsDir="${project.build.directory}" docsSubdir="docs" />
+		<docs docsDir="${project.build.directory}" docsSubdir="apidocs" />
 		<docs
 			freemarkerTemplate="${project.basedir}/src/main/resources/META-INF/enunciate/d4science_docs.fmt">
 			<additional-css

pom.xml

@@ -12,7 +12,7 @@
 	<groupId>org.gcube.portal</groupId>
 	<artifactId>social-networking-library-ws</artifactId>
 	<packaging>war</packaging>
-	<version>2.6.2</version>
+	<version>2.7.0-SNAPSHOT</version>
 	<name>social-networking-library-ws</name>
 	<description>Rest interface for the social networking library.</description>
 	<properties>
@@ -301,6 +301,26 @@
 
 	<build>
 		<plugins>
+			<!-- SPHINX PLUGIN triggered at 'compile' -->
+			<plugin>
+				<groupId>kr.motd.maven</groupId>
+				<artifactId>sphinx-maven-plugin</artifactId>
+				<version>2.10.0</version>
+				<configuration>
+					<outputDirectory>${project.build.directory}/docs</outputDirectory>
+					<builder>html</builder>
+					<configDirectory>${basedir}/docs</configDirectory>
+					<sourceDirectory>${basedir}/docs</sourceDirectory>
+				</configuration>
+				<executions>
+					<execution>
+						<phase>process-resources</phase>
+						<goals>
+							<goal>generate</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
 			<!-- Enunciate Maven plugin -->
 			<plugin>
 				<groupId>com.webcohesion.enunciate</groupId>
@@ -345,8 +365,8 @@
 							<outputDirectory>target</outputDirectory>
 							<resources>
 								<resource>
-									<targetPath>${project.build.directory}/${project.artifactId}-${project.version}/docs</targetPath>
-									<directory>${project.build.directory}/docs</directory>
+									<targetPath>${project.build.directory}/${project.artifactId}-${project.version}/apidocs</targetPath>
+									<directory>${project.build.directory}/apidocs</directory>
 									<filtering>true</filtering>
 								</resource>
 							</resources>

src/main/java/org/gcube/portal/social/networking/ws/docs/DocsGenerator.java

@@ -13,7 +13,7 @@ import javax.ws.rs.core.Context;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-@Path("docs")
+@Path("apidocs")
 public class DocsGenerator {
 
     private static Logger logger = LoggerFactory.getLogger(DocsGenerator.class);
@@ -27,7 +27,7 @@ public class DocsGenerator {
         logger.debug("pathInfo {}", pathInfo);
         try {
 
-            if (pathInfo.endsWith("/docs/")) {
+            if (pathInfo.endsWith("/apidocs/")) {
                 pathInfo += "index.html";
             }