Skip to content

Commit

Permalink
[DOCS] Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@Baunsgaard
Baunsgaard committed Aug 30, 2024
1 parent 1127c6a commit 64e60f6
Show file tree
Hide file tree
Showing 4,107 changed files with 80,359 additions and 78,143 deletions.
The diff you're trying to view is too large. We only load the first 3000 changed files.
2 changes: 1 addition & 1 deletion docs/_config.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@

# Documentation https://jekyllrb.com/docs/configuration/options/#build-command-options

baseurl: "systemds" # the subpath of your site, e.g. /blog
baseurl: "/systemds" # the subpath of your site, e.g. /blog
url: "http://systemds.apache.org" # the base hostname & protocol for your site

highlighter: rouge
Expand Down
4,003 changes: 2,018 additions & 1,985 deletions docs/api/java/allclasses-index.html
View file

Large diffs are not rendered by default.

121 changes: 64 additions & 57 deletions docs/api/java/allclasses.html
View file

Large diffs are not rendered by default.

129 changes: 63 additions & 66 deletions docs/api/java/allpackages-index.html
View file

Large diffs are not rendered by default.

455 changes: 365 additions & 90 deletions docs/api/java/constant-values.html
View file

Large diffs are not rendered by default.

11 changes: 6 additions & 5 deletions docs/api/java/deprecated-list.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,25 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>Deprecated List (Apache SystemDS 3.2.0-SNAPSHOT API)</title>
<title>Deprecated List (Apache SystemDS 3.3.0-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.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.5.1.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
<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="Deprecated List (Apache SystemDS 3.2.0-SNAPSHOT API)";
parent.document.title="Deprecated List (Apache SystemDS 3.3.0-SNAPSHOT API)";
}
}
catch(err) {
Expand Down
7 changes: 3 additions & 4 deletions docs/api/java/element-list
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ org.apache.sysds.lops.compile.linearization
org.apache.sysds.lops.rewrite
org.apache.sysds.parser
org.apache.sysds.parser.dml
org.apache.sysds.resource
org.apache.sysds.resource.cost
org.apache.sysds.resource.enumeration
org.apache.sysds.runtime
org.apache.sysds.runtime.codegen
org.apache.sysds.runtime.compress
Expand Down Expand Up @@ -61,7 +64,6 @@ org.apache.sysds.runtime.controlprogram.paramserv.homomorphicEncryption
org.apache.sysds.runtime.controlprogram.paramserv.rpc
org.apache.sysds.runtime.controlprogram.parfor
org.apache.sysds.runtime.controlprogram.parfor.opt
org.apache.sysds.runtime.controlprogram.parfor.stat
org.apache.sysds.runtime.controlprogram.parfor.util
org.apache.sysds.runtime.data
org.apache.sysds.runtime.frame.data
Expand Down Expand Up @@ -93,9 +95,6 @@ org.apache.sysds.runtime.matrix.data.sketch.countdistinct
org.apache.sysds.runtime.matrix.data.sketch.countdistinctapprox
org.apache.sysds.runtime.matrix.operators
org.apache.sysds.runtime.meta
org.apache.sysds.runtime.privacy
org.apache.sysds.runtime.privacy.finegrained
org.apache.sysds.runtime.privacy.propagation
org.apache.sysds.runtime.transform
org.apache.sysds.runtime.transform.decode
org.apache.sysds.runtime.transform.encode
Expand Down
37 changes: 19 additions & 18 deletions docs/api/java/help-doc.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,25 @@
<html lang="en">
<head>
<!-- Generated by javadoc -->
<title>API Help (Apache SystemDS 3.2.0-SNAPSHOT API)</title>
<title>API Help (Apache SystemDS 3.3.0-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.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.5.1.js"></script>
<script type="text/javascript" src="jquery/jquery-ui.js"></script>
<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="API Help (Apache SystemDS 3.2.0-SNAPSHOT API)";
parent.document.title="API Help (Apache SystemDS 3.3.0-SNAPSHOT API)";
}
}
catch(err) {
Expand Down Expand Up @@ -99,13 +100,13 @@ <h1 class="title">How This API Document Is Organized</h1>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<section role="region">
<section>
<h2>Overview</h2>
<p>The <a href="index.html">Overview</a> page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.</p>
</section>
</li>
<li class="blockList">
<section role="region">
<section>
<h2>Package</h2>
<p>Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:</p>
<ul>
Expand All @@ -119,7 +120,7 @@ <h2>Package</h2>
</section>
</li>
<li class="blockList">
<section role="region">
<section>
<h2>Class or Interface</h2>
<p>Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:</p>
<ul>
Expand Down Expand Up @@ -149,7 +150,7 @@ <h2>Class or Interface</h2>
</section>
</li>
<li class="blockList">
<section role="region">
<section>
<h2>Annotation Type</h2>
<p>Each annotation type has its own separate page with the following sections:</p>
<ul>
Expand All @@ -162,7 +163,7 @@ <h2>Annotation Type</h2>
</section>
</li>
<li class="blockList">
<section role="region">
<section>
<h2>Enum</h2>
<p>Each enum has its own separate page with the following sections:</p>
<ul>
Expand All @@ -174,13 +175,13 @@ <h2>Enum</h2>
</section>
</li>
<li class="blockList">
<section role="region">
<section>
<h2>Use</h2>
<p>Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its "Use" page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.</p>
</section>
</li>
<li class="blockList">
<section role="region">
<section>
<h2>Tree (Class Hierarchy)</h2>
<p>There is a <a href="overview-tree.html">Class Hierarchy</a> page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with <code>java.lang.Object</code>. Interfaces do not inherit from <code>java.lang.Object</code>.</p>
<ul>
Expand All @@ -190,37 +191,37 @@ <h2>Tree (Class Hierarchy)</h2>
</section>
</li>
<li class="blockList">
<section role="region">
<section>
<h2>Deprecated API</h2>
<p>The <a href="deprecated-list.html">Deprecated API</a> page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.</p>
</section>
</li>
<li class="blockList">
<section role="region">
<section>
<h2>Index</h2>
<p>The <a href="index-all.html">Index</a> contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.</p>
</section>
</li>
<li class="blockList">
<section role="region">
<section>
<h2>All&nbsp;Classes</h2>
<p>The <a href="allclasses.html">All Classes</a> link shows all classes and interfaces except non-static nested types.</p>
</section>
</li>
<li class="blockList">
<section role="region">
<section>
<h2>Serialized Form</h2>
<p>Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.</p>
</section>
</li>
<li class="blockList">
<section role="region">
<section>
<h2>Constant Field Values</h2>
<p>The <a href="constant-values.html">Constant Field Values</a> page lists the static final fields and their values.</p>
</section>
</li>
<li class="blockList">
<section role="region">
<section>
<h2>Search</h2>
<p>You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".</p>
</section>
Expand Down
Loading

0 comments on commit 64e60f6

Please sign in to comment.