Fixing documentation generation
This commit is contained in:
parent
bf0caa01c5
commit
47caed1e16
|
@ -14,8 +14,10 @@
|
|||
<ruby-json-client disabled="true" />
|
||||
<java-json-client disabled="true" />
|
||||
<javascript-client disabled="true" />
|
||||
<java-xml-client disabled="true" />
|
||||
<jaxws disabled="true" />
|
||||
<jaxb disabled="true" />
|
||||
|
||||
<jaxb-xml-client disabled="true" />
|
||||
<c-xml-client disabled="true" />
|
||||
<csharp-xml-client disabled="true" />
|
||||
<obj-c-xml-client disabled="true" />
|
||||
|
@ -24,9 +26,9 @@
|
|||
|
||||
<docs docsDir="${project.build.directory}" docsSubdir="api-docs" />
|
||||
<swagger basePath="/${project.artifactId}" />
|
||||
<docs freemarkerTemplate="${project.basedir}/src/main/resources/META-INF/enunciate/d4science_docs.fmt">
|
||||
<additional-css
|
||||
file="css/d4science_enunciate_custom.css" />
|
||||
<docs
|
||||
freemarkerTemplate="${project.basedir}${file.separator}src${file.separator}main${file.separator}resources${file.separator}META-INF${file.separator}enunciate${file.separator}d4science_docs.fmt">
|
||||
<additional-css file="css${file.separator}d4science_enunciate_custom.css" />
|
||||
</docs>
|
||||
</modules>
|
||||
</enunciate>
|
|
@ -499,3 +499,10 @@ The maven coordinates of the gCat service are:
|
|||
<groupId>org.gcube.data-catalogue</groupId>
|
||||
<artifactId>gcat</artifactId>
|
||||
|
||||
|
||||
Postman Collection
|
||||
=======================
|
||||
|
||||
Here you can download the `postman collection to interact with the gCat service <../api-docs/postman/gcat.postman_collection.json>`_.
|
||||
|
||||
|
14
pom.xml
14
pom.xml
|
@ -292,10 +292,10 @@
|
|||
<artifactId>sphinx-maven-plugin</artifactId>
|
||||
<version>2.10.0</version>
|
||||
<configuration>
|
||||
<outputDirectory>${project.build.directory}/${project.artifactId}-${project.version}/docs</outputDirectory>
|
||||
<outputDirectory>${project.build.directory}${file.separator}${project.build.finalName}${file.separator}docs</outputDirectory>
|
||||
<builder>html</builder>
|
||||
<configDirectory>${basedir}/sphinx</configDirectory>
|
||||
<sourceDirectory>${basedir}/sphinx</sourceDirectory>
|
||||
<configDirectory>${project.basedir}${file.separator}documentation${file.separator}sphinx</configDirectory>
|
||||
<sourceDirectory>${project.basedir}${file.separator}documentation${file.separator}sphinx</sourceDirectory>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
|
@ -320,6 +320,12 @@
|
|||
</goals>
|
||||
</execution>
|
||||
</executions>
|
||||
<configuration>
|
||||
<!-- This does not works as expected. We need to use the maven-resources-plugin below
|
||||
<docsDir>${project.build.directory}${file.separator}${project.artifactId}-${project.version}${file.separator}api-docs</docsDir>
|
||||
-->
|
||||
<configFile>${project.basedir}${file.separator}documentation${file.separator}enunciate${file.separator}enunciate.xml</configFile>
|
||||
</configuration>
|
||||
</plugin>
|
||||
<!-- Copy Enunciate Documentation from your-application/api-docs into your war -->
|
||||
<plugin>
|
||||
|
@ -336,7 +342,7 @@
|
|||
<outputDirectory>target</outputDirectory>
|
||||
<resources>
|
||||
<resource>
|
||||
<targetPath>${project.build.directory}/${project.artifactId}-${project.version}/api-docs</targetPath>
|
||||
<targetPath>${project.build.directory}${file.separator}${project.artifactId}-${project.version}${file.separator}api-docs</targetPath>
|
||||
<directory>${project.build.directory}/api-docs</directory>
|
||||
<filtering>true</filtering>
|
||||
</resource>
|
||||
|
|
File diff suppressed because one or more lines are too long
Loading…
Reference in New Issue