Generate Docs

UncleXie123 · May 15, 2024 · cb07250 · cb07250
1 parent 7924ca6
commit cb07250
Show file tree

Hide file tree

Showing 11 changed files with 33 additions and 12 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -31,4 +31,6 @@ jobs:
       uses: actions/upload-artifact@v3
       with:
         name: build
-        path: build/
+        path: build/
+    - name: Generate Docs
+      run: ./gradlew generateDocs
diff --git a/.gradle/7.4.2/checksums/checksums.lock b/.gradle/7.4.2/checksums/checksums.lock
diff --git a/.gradle/7.4.2/executionHistory/executionHistory.bin b/.gradle/7.4.2/executionHistory/executionHistory.bin
diff --git a/.gradle/7.4.2/executionHistory/executionHistory.lock b/.gradle/7.4.2/executionHistory/executionHistory.lock
diff --git a/.gradle/7.4.2/fileHashes/fileHashes.bin b/.gradle/7.4.2/fileHashes/fileHashes.bin
diff --git a/.gradle/7.4.2/fileHashes/fileHashes.lock b/.gradle/7.4.2/fileHashes/fileHashes.lock
diff --git a/.gradle/buildOutputCleanup/buildOutputCleanup.lock b/.gradle/buildOutputCleanup/buildOutputCleanup.lock
diff --git a/build.gradle b/build.gradle
@@ -21,6 +21,7 @@ buildscript {
 		mavenCentral()
 	}
 	dependencies {
+        classpath 'io.opencaesar.owl:owl-doc-gradle:2.+'
         classpath 'io.opencaesar.owl:owl-fuseki-gradle:+'
         classpath 'io.opencaesar.owl:owl-query-gradle:+'
         classpath 'io.opencaesar.owl:owl-load-gradle:+'
@@ -95,6 +96,24 @@ task owlReason(type:io.opencaesar.owl.reason.OwlReasonTask, group:"oml", depends
     reportPath = file('build/reports/reasoning.xml')
 }
 
+/*
+ * A task to generate documentation for the OWL catalog
+ * @seeAlso https://github.com/opencaesar/owl-tools/blob/master/owl-doc/README.md
+ */
+task generateDocs(type: io.opencaesar.owl.doc.OwlDocTask, dependsOn: owlReason) {
+    // OWL catalog
+    inputCatalogPath = file('build/owl/catalog.xml')
+    // OWL catalog title
+    inputCatalogTitle = 'Kepler16b'
+    // OWL catalog version
+    inputCatalogVersion = project.version
+    // OWL Ontology Iris
+    inputOntologyIris = [ "$rootIri/classes", "$rootIri/properties",  "$rootIri/individuals" ]
+    // Output folder
+    outputFolderPath = file('build/web/doc')
+    // Output case sensitivie path
+    outputCaseSensitive = org.gradle.internal.os.OperatingSystem.current().isLinux()
+}
 
 /*
  * Start the headless Fuseki server

diff --git a/build/owl/example.com/tutorial2/description/bundle/classes.ttl b/build/owl/example.com/tutorial2/description/bundle/classes.ttl
@@ -192,7 +192,7 @@ owl:Nothing  rdf:type  owl:Class .
 
 <http://example.com/tutorial2/vocabulary/mission#Objective>
         rdf:type         owl:Class ;
-        rdfs:subClassOf  <http://example.com/tutorial2/vocabulary/base#AggregatedThing> , <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , <http://example.com/tutorial2/vocabulary/mission#Objective> .
+        rdfs:subClassOf  <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , <http://example.com/tutorial2/vocabulary/base#AggregatedThing> , <http://example.com/tutorial2/vocabulary/mission#Objective> .
 
 <http://bipm.org/jcgm/vim4#Describes>
         rdf:type         owl:Class ;
@@ -230,7 +230,7 @@ owl:Nothing  rdf:type  owl:Class .
 
 <http://bipm.org/jcgm/vim4#OrdinalQuantityValue>
         rdf:type         owl:Class ;
-        rdfs:subClassOf  <http://bipm.org/jcgm/vim4#IndividualOrdinalQuantity> , <http://bipm.org/jcgm/vim4#IndividualQuantity> , <http://bipm.org/jcgm/vim4#QuantityValue> , <http://bipm.org/jcgm/vim4#IndividualProperty> , <http://bipm.org/jcgm/vim4#IdentifiedElement> , <http://bipm.org/jcgm/vim4#OrdinalQuantityValue> .
+        rdfs:subClassOf  <http://bipm.org/jcgm/vim4#QuantityValue> , <http://bipm.org/jcgm/vim4#IndividualQuantity> , <http://bipm.org/jcgm/vim4#IndividualOrdinalQuantity> , <http://bipm.org/jcgm/vim4#IndividualProperty> , <http://bipm.org/jcgm/vim4#IdentifiedElement> , <http://bipm.org/jcgm/vim4#OrdinalQuantityValue> .
 
 <http://example.com/tutorial2/vocabulary/mission#isDeployedBy>
         rdf:type  owl:ObjectProperty .
@@ -337,7 +337,7 @@ owl:topDataProperty  rdf:type  owl:DatatypeProperty .
         rdf:type         owl:Ontology ;
         rdfs:comment     "Generated by Owl Reason 2.8.1" ;
         owl:imports      <http://example.com/tutorial2/description/bundle> ;
-        owl:versionInfo  "1715675170" .
+        owl:versionInfo  "1715754800" .
 
 <http://example.com/tutorial2/vocabulary/mission#Deploys>
         rdf:type         owl:Class ;
@@ -371,7 +371,7 @@ owl:topDataProperty  rdf:type  owl:DatatypeProperty .
 
 <http://example.com/tutorial2/vocabulary/mechanical#MechanicalComponent>
         rdf:type         owl:Class ;
-        rdfs:subClassOf  <http://bipm.org/jcgm/vim4#Object> , <http://example.com/tutorial2/vocabulary/base#ContainedElement> , <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , <http://example.com/tutorial2/vocabulary/mission#Component> , <http://example.com/tutorial2/vocabulary/mechanical#MechanicalComponent> .
+        rdfs:subClassOf  <http://bipm.org/jcgm/vim4#Object> , <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , <http://example.com/tutorial2/vocabulary/base#ContainedElement> , <http://example.com/tutorial2/vocabulary/mission#Component> , <http://example.com/tutorial2/vocabulary/mechanical#MechanicalComponent> .
 
 <http://bipm.org/jcgm/vim4#systemHasUnit>
         rdf:type  owl:ObjectProperty .
@@ -402,7 +402,7 @@ owl:topDataProperty  rdf:type  owl:DatatypeProperty .
 
 <http://example.com/tutorial2/vocabulary/mission#Component>
         rdf:type         owl:Class ;
-        rdfs:subClassOf  <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , <http://example.com/tutorial2/vocabulary/base#ContainedElement> , <http://example.com/tutorial2/vocabulary/mission#Component> .
+        rdfs:subClassOf  <http://example.com/tutorial2/vocabulary/base#ContainedElement> , <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , <http://example.com/tutorial2/vocabulary/mission#Component> .
 
 <http://bipm.org/jcgm/vim4#InherentUnitaryQuantityValue>
         rdf:type         owl:Class ;

diff --git a/build/owl/example.com/tutorial2/description/bundle/individuals.ttl b/build/owl/example.com/tutorial2/description/bundle/individuals.ttl
@@ -479,7 +479,7 @@ owl:topObjectProperty
         rdf:type  owl:Class .
 
 <http://example.com/tutorial2/description/components#mission-operations-system>
-        rdf:type    <http://example.com/tutorial2/vocabulary/mission#Component> , <http://example.com/tutorial2/vocabulary/base#ContainedElement> , <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , owl:Thing ;
+        rdf:type    <http://example.com/tutorial2/vocabulary/mission#Component> , <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , <http://example.com/tutorial2/vocabulary/base#ContainedElement> , owl:Thing ;
         <http://example.com/tutorial2/vocabulary/base#hasCanonicalName>
                 "Mission Operations System" ;
         <http://example.com/tutorial2/vocabulary/base#hasIdentifier>
@@ -513,7 +513,7 @@ owl:topObjectProperty
         rdf:type         owl:Ontology ;
         rdfs:comment     "Generated by Owl Reason 2.8.1" ;
         owl:imports      <http://example.com/tutorial2/description/bundle> ;
-        owl:versionInfo  "1715675170" .
+        owl:versionInfo  "1715754800" .
 
 <http://bipm.org/jcgm/vim4#IndividualNominalProperty>
         rdf:type  owl:Class .
@@ -760,7 +760,7 @@ owl:topObjectProperty
         rdf:type  owl:Class .
 
 <http://example.com/tutorial2/description/objectives#characterize-rocky-core-shape>
-        rdf:type    <http://example.com/tutorial2/vocabulary/mission#Objective> , <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , <http://example.com/tutorial2/vocabulary/base#AggregatedThing> , owl:Thing ;
+        rdf:type    <http://example.com/tutorial2/vocabulary/mission#Objective> , <http://example.com/tutorial2/vocabulary/base#AggregatedThing> , <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , owl:Thing ;
         <http://example.com/tutorial2/vocabulary/base#hasCanonicalName>
                 "Characterize the core shape of Kepler 16b" ;
         <http://example.com/tutorial2/vocabulary/base#hasIdentifier>
@@ -970,7 +970,7 @@ owl:Thing  rdf:type  owl:Class .
         owl:sameAs                      <http://iso.org/iso-80000-1#femto> .
 
 <http://example.com/tutorial2/description/objectives#characterize-rocky-core-density>
-        rdf:type    <http://example.com/tutorial2/vocabulary/mission#Objective> , <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , <http://example.com/tutorial2/vocabulary/base#AggregatedThing> , owl:Thing ;
+        rdf:type    <http://example.com/tutorial2/vocabulary/mission#Objective> , <http://example.com/tutorial2/vocabulary/base#AggregatedThing> , <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , owl:Thing ;
         <http://example.com/tutorial2/vocabulary/base#hasCanonicalName>
                 "Characterize the core density of Kepler 16b" ;
         <http://example.com/tutorial2/vocabulary/base#hasIdentifier>
@@ -1100,7 +1100,7 @@ owl:Thing  rdf:type  owl:Class .
         rdf:type  owl:FunctionalProperty , owl:DatatypeProperty .
 
 <http://example.com/tutorial2/description/components#lander-ground-data-system>
-        rdf:type    <http://example.com/tutorial2/vocabulary/mission#Component> , <http://example.com/tutorial2/vocabulary/base#ContainedElement> , <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , owl:Thing ;
+        rdf:type    <http://example.com/tutorial2/vocabulary/mission#Component> , <http://example.com/tutorial2/vocabulary/base#IdentifiedThing> , <http://example.com/tutorial2/vocabulary/base#ContainedElement> , owl:Thing ;
         <http://example.com/tutorial2/vocabulary/base#hasCanonicalName>
                 "Lander Ground Data System" ;
         <http://example.com/tutorial2/vocabulary/base#hasIdentifier>

diff --git a/build/owl/example.com/tutorial2/description/bundle/properties.ttl b/build/owl/example.com/tutorial2/description/bundle/properties.ttl
@@ -387,7 +387,7 @@ owl:topDataProperty  rdf:type  owl:DatatypeProperty .
         rdf:type         owl:Ontology ;
         rdfs:comment     "Generated by Owl Reason 2.8.1" ;
         owl:imports      <http://example.com/tutorial2/description/bundle> ;
-        owl:versionInfo  "1715675170" .
+        owl:versionInfo  "1715754800" .
 
 <http://bipm.org/jcgm/vim4#MeasurementProcedure>
         rdf:type  owl:Class .