Testing out deploy of javadocs

marklogic · Jun 13, 2024 · b470e4b · b470e4b
1 parent 6511690
commit b470e4b
Show file tree

Hide file tree

Showing 105 changed files with 48,688 additions and 1 deletion.
diff --git a/.github/workflows/jekyll-gh-pages.yml b/.github/workflows/jekyll-gh-pages.yml
@@ -4,7 +4,7 @@ name: Deploy Jekyll with GitHub Pages dependencies preinstalled
 on:
   # Runs on pushes targeting the default branch.
   push:
-    branches: ["main"]
+    branches: ["feature/javadoc-test"]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -48,3 +48,24 @@ jobs:
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v1
+
+  publish:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write  # if you have a protection rule on your repository, you'll need to give write permission to the workflow.
+    steps:
+      - name: Publish marklogic-spark-connector
+        run: |
+          git clone https://github.com/marklogic/marklogic-spark-connector.git
+          cd marklogic-spark-connector
+          git checkout develop
+          ./gradlew publishToMavenLocal
+      - name: Deploy JavaDoc
+        uses: MathieuSoysal/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          javadoc-branch: feature/javadoc-test
+          java-version: 11
+          target-folder: javadoc
+          javadoc-source-folder: flux-cli/build/docs/javadoc
+          project: gradle
diff --git a/docs/assets/javadoc/allclasses-index.html b/docs/assets/javadoc/allclasses-index.html
diff --git a/docs/assets/javadoc/allclasses.html b/docs/assets/javadoc/allclasses.html
@@ -0,0 +1,91 @@
+<!DOCTYPE HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>All Classes (flux-cli 0.3-SNAPSHOT API)</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
+<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
+<!--[if IE]>
+<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
+<![endif]-->
+<script type="text/javascript" src="jquery/jquery-3.6.1.min.js"></script>
+<script type="text/javascript" src="jquery/jquery-ui.min.js"></script>
+</head>
+<body>
+<main role="main">
+<h1 class="bar">All&nbsp;Classes</h1>
+<div class="indexContainer">
+<ul>
+<li><a href="com/marklogic/flux/api/AggregateXmlFilesImporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">AggregateXmlFilesImporter</span></a></li>
+<li><a href="com/marklogic/flux/api/AggregateXmlFilesImporter.ReadXmlFilesOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">AggregateXmlFilesImporter.ReadXmlFilesOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/ArchiveFilesExporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">ArchiveFilesExporter</span></a></li>
+<li><a href="com/marklogic/flux/api/ArchiveFilesExporter.ReadArchiveDocumentOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">ArchiveFilesExporter.ReadArchiveDocumentOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/ArchiveFilesImporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">ArchiveFilesImporter</span></a></li>
+<li><a href="com/marklogic/flux/api/ArchiveFilesImporter.ReadArchiveFilesOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">ArchiveFilesImporter.ReadArchiveFilesOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/AuthenticationType.html" title="enum in com.marklogic.flux.api">AuthenticationType</a></li>
+<li><a href="com/marklogic/flux/api/AvroFilesExporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">AvroFilesExporter</span></a></li>
+<li><a href="com/marklogic/flux/api/AvroFilesImporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">AvroFilesImporter</span></a></li>
+<li><a href="com/marklogic/flux/api/CompressionType.html" title="enum in com.marklogic.flux.api">CompressionType</a></li>
+<li><a href="com/marklogic/flux/api/ConnectionOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">ConnectionOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/CustomDocumentsExporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">CustomDocumentsExporter</span></a></li>
+<li><a href="com/marklogic/flux/api/CustomExportWriteOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">CustomExportWriteOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/CustomImporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">CustomImporter</span></a></li>
+<li><a href="com/marklogic/flux/api/CustomImporter.CustomReadOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">CustomImporter.CustomReadOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/CustomRowsExporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">CustomRowsExporter</span></a></li>
+<li><a href="com/marklogic/flux/api/DelimitedFilesExporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">DelimitedFilesExporter</span></a></li>
+<li><a href="com/marklogic/flux/api/DelimitedFilesImporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">DelimitedFilesImporter</span></a></li>
+<li><a href="com/marklogic/flux/api/DocumentCopier.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">DocumentCopier</span></a></li>
+<li><a href="com/marklogic/flux/api/DocumentCopier.CopyReadDocumentsOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">DocumentCopier.CopyReadDocumentsOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/Executor.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">Executor</span></a></li>
+<li><a href="com/marklogic/flux/api/Flux.html" title="class in com.marklogic.flux.api">Flux</a></li>
+<li><a href="com/marklogic/flux/api/FluxException.html" title="class in com.marklogic.flux.api">FluxException</a></li>
+<li><a href="com/marklogic/flux/api/GenericFilesExporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">GenericFilesExporter</span></a></li>
+<li><a href="com/marklogic/flux/api/GenericFilesExporter.WriteGenericFilesOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">GenericFilesExporter.WriteGenericFilesOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/GenericFilesImporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">GenericFilesImporter</span></a></li>
+<li><a href="com/marklogic/flux/api/GenericFilesImporter.DocumentType.html" title="enum in com.marklogic.flux.api">GenericFilesImporter.DocumentType</a></li>
+<li><a href="com/marklogic/flux/api/GenericFilesImporter.ReadGenericFilesOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">GenericFilesImporter.ReadGenericFilesOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/GenericFilesImporter.WriteGenericDocumentsOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">GenericFilesImporter.WriteGenericDocumentsOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/JdbcExporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">JdbcExporter</span></a></li>
+<li><a href="com/marklogic/flux/api/JdbcExporter.WriteRowsOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">JdbcExporter.WriteRowsOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/JdbcImporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">JdbcImporter</span></a></li>
+<li><a href="com/marklogic/flux/api/JdbcImporter.ReadJdbcOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">JdbcImporter.ReadJdbcOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/JdbcOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">JdbcOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/JsonFilesImporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">JsonFilesImporter</span></a></li>
+<li><a href="com/marklogic/flux/api/JsonFilesImporter.ReadJsonFilesOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">JsonFilesImporter.ReadJsonFilesOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/JsonLinesFilesExporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">JsonLinesFilesExporter</span></a></li>
+<li><a href="com/marklogic/flux/api/MlcpArchiveFilesImporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">MlcpArchiveFilesImporter</span></a></li>
+<li><a href="com/marklogic/flux/api/MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">MlcpArchiveFilesImporter.ReadMlcpArchiveFilesOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/OrcFilesExporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">OrcFilesExporter</span></a></li>
+<li><a href="com/marklogic/flux/api/OrcFilesImporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">OrcFilesImporter</span></a></li>
+<li><a href="com/marklogic/flux/api/ParquetFilesExporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">ParquetFilesExporter</span></a></li>
+<li><a href="com/marklogic/flux/api/ParquetFilesImporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">ParquetFilesImporter</span></a></li>
+<li><a href="com/marklogic/flux/api/RdfFilesExporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">RdfFilesExporter</span></a></li>
+<li><a href="com/marklogic/flux/api/RdfFilesExporter.ReadTriplesDocumentsOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">RdfFilesExporter.ReadTriplesDocumentsOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/RdfFilesExporter.WriteRdfFilesOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">RdfFilesExporter.WriteRdfFilesOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/RdfFilesImporter.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">RdfFilesImporter</span></a></li>
+<li><a href="com/marklogic/flux/api/RdfFilesImporter.ReadRdfFilesOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">RdfFilesImporter.ReadRdfFilesOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/RdfFilesImporter.WriteTriplesDocumentsOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">RdfFilesImporter.WriteTriplesDocumentsOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/ReadDocumentsOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">ReadDocumentsOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/ReadFilesOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">ReadFilesOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/ReadRowsOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">ReadRowsOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/ReadSparkFilesOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">ReadSparkFilesOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/Reprocessor.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">Reprocessor</span></a></li>
+<li><a href="com/marklogic/flux/api/Reprocessor.ReadOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">Reprocessor.ReadOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/Reprocessor.WriteOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">Reprocessor.WriteOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/SaveMode.html" title="enum in com.marklogic.flux.api">SaveMode</a></li>
+<li><a href="com/marklogic/flux/api/SslHostnameVerifier.html" title="enum in com.marklogic.flux.api">SslHostnameVerifier</a></li>
+<li><a href="com/marklogic/flux/api/WriteDocumentsOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">WriteDocumentsOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/WriteFilesOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">WriteFilesOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/WriteSparkFilesOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">WriteSparkFilesOptions</span></a></li>
+<li><a href="com/marklogic/flux/api/WriteStructuredDocumentsOptions.html" title="interface in com.marklogic.flux.api"><span class="interfaceName">WriteStructuredDocumentsOptions</span></a></li>
+</ul>
+</div>
+</main>
+</body>
+</html>
diff --git a/docs/assets/javadoc/allpackages-index.html b/docs/assets/javadoc/allpackages-index.html
@@ -0,0 +1,167 @@
+<!DOCTYPE HTML>
+<!-- NewPage -->
+<html lang="en">
+<head>
+<!-- Generated by javadoc -->
+<title>All Packages (flux-cli 0.3-SNAPSHOT API)</title>
+<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery/jquery-ui.min.css" title="Style">
+<link rel="stylesheet" type="text/css" href="jquery-ui.overrides.css" title="Style">
+<script type="text/javascript" src="script.js"></script>
+<script type="text/javascript" src="jquery/jszip/dist/jszip.min.js"></script>
+<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils.min.js"></script>
+<!--[if IE]>
+<script type="text/javascript" src="jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
+<![endif]-->
+<script type="text/javascript" src="jquery/jquery-3.6.1.min.js"></script>
+<script type="text/javascript" src="jquery/jquery-ui.min.js"></script>
+</head>
+<body>
+<script type="text/javascript"><!--
+    try {
+        if (location.href.indexOf('is-external=true') == -1) {
+            parent.document.title="All Packages (flux-cli 0.3-SNAPSHOT API)";
+        }
+    }
+    catch(err) {
+    }
+//-->
+var pathtoroot = "./";
+var useModuleDirectories = true;
+loadScripts(document, 'script');</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+<header role="banner">
+<nav role="navigation">
+<div class="fixedNav">
+<!-- ========= START OF TOP NAVBAR ======= -->
+<div class="topNav"><a id="navbar.top">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
+<a id="navbar.top.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="com/marklogic/flux/api/package-summary.html">Package</a></li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList" id="allclasses_navbar_top">
+<li><a href="allclasses.html">All&nbsp;Classes</a></li>
+</ul>
+<ul class="navListSearch">
+<li><label for="search">SEARCH:</label>
+<input type="text" id="search" value="search" disabled="disabled">
+<input type="reset" id="reset" value="reset" disabled="disabled">
+</li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_top");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+</div>
+<a id="skip.navbar.top">
+<!--   -->
+</a></div>
+<!-- ========= END OF TOP NAVBAR ========= -->
+</div>
+<div class="navPadding">&nbsp;</div>
+<script type="text/javascript"><!--
+$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
+//-->
+</script>
+</nav>
+</header>
+<main role="main">
+<div class="header">
+<h1 title="All&amp;nbsp;Packages" class="title">All&nbsp;Packages</h1>
+</div>
+<div class="allPackagesContainer">
+<ul class="blockList">
+<li class="blockList">
+<table class="packagesSummary">
+<caption><span>Package Summary</span><span class="tabEnd">&nbsp;</span></caption>
+<tr>
+<th class="colFirst" scope="col">Package</th>
+<th class="colLast" scope="col">Description</th>
+</tr>
+<tbody>
+<tr class="altColor">
+<th class="colFirst" scope="row"><a href="com/marklogic/flux/api/package-summary.html">com.marklogic.flux.api</a></th>
+<td class="colLast">
+<div class="block">
+ All Flux functionality can be accessed starting with the
+ <a href="com/marklogic/flux/api/Flux.html" title="class in com.marklogic.flux.api"><code>Flux</code></a> class, which provides a static method corresponding to each
+ command available in the Flux CLI.</div>
+</td>
+</tr>
+</tbody>
+</table>
+</li>
+</ul>
+</div>
+</main>
+<footer role="contentinfo">
+<nav role="navigation">
+<!-- ======= START OF BOTTOM NAVBAR ====== -->
+<div class="bottomNav"><a id="navbar.bottom">
+<!--   -->
+</a>
+<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
+<a id="navbar.bottom.firstrow">
+<!--   -->
+</a>
+<ul class="navList" title="Navigation">
+<li><a href="com/marklogic/flux/api/package-summary.html">Package</a></li>
+<li>Class</li>
+<li><a href="overview-tree.html">Tree</a></li>
+<li><a href="deprecated-list.html">Deprecated</a></li>
+<li><a href="index-all.html">Index</a></li>
+<li><a href="help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="allclasses.html">All&nbsp;Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+  allClassesLink = document.getElementById("allclasses_navbar_bottom");
+  if(window==top) {
+    allClassesLink.style.display = "block";
+  }
+  else {
+    allClassesLink.style.display = "none";
+  }
+  //-->
+</script>
+<noscript>
+<div>JavaScript is disabled on your browser.</div>
+</noscript>
+</div>
+<a id="skip.navbar.bottom">
+<!--   -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+</nav>
+</footer>
+</body>
+</html>