mv docs for github pages

webis-de · Jun 19, 2024 · 0c7b7c6 · 0c7b7c6
1 parent 4615866
commit 0c7b7c6
Show file tree

Hide file tree

Showing 28 changed files with 60 additions and 69 deletions.
diff --git a/docs/api/assets/anchor.js → docs/assets/anchor.js b/docs/api/assets/anchor.js → docs/assets/anchor.js
diff --git a/docs/api/assets/bass-addons.css → docs/assets/bass-addons.css b/docs/api/assets/bass-addons.css → docs/assets/bass-addons.css
diff --git a/docs/api/assets/bass.css → docs/assets/bass.css b/docs/api/assets/bass.css → docs/assets/bass.css
diff --git a/...i/assets/fonts/EOT/SourceCodePro-Bold.eot → docs/assets/fonts/EOT/SourceCodePro-Bold.eot b/...i/assets/fonts/EOT/SourceCodePro-Bold.eot → docs/assets/fonts/EOT/SourceCodePro-Bold.eot
diff --git a/...ssets/fonts/EOT/SourceCodePro-Regular.eot → ...ssets/fonts/EOT/SourceCodePro-Regular.eot b/...ssets/fonts/EOT/SourceCodePro-Regular.eot → ...ssets/fonts/EOT/SourceCodePro-Regular.eot
diff --git a/docs/api/assets/fonts/LICENSE.txt → docs/assets/fonts/LICENSE.txt b/docs/api/assets/fonts/LICENSE.txt → docs/assets/fonts/LICENSE.txt
diff --git a/...i/assets/fonts/OTF/SourceCodePro-Bold.otf → docs/assets/fonts/OTF/SourceCodePro-Bold.otf b/...i/assets/fonts/OTF/SourceCodePro-Bold.otf → docs/assets/fonts/OTF/SourceCodePro-Bold.otf
diff --git a/...ssets/fonts/OTF/SourceCodePro-Regular.otf → ...ssets/fonts/OTF/SourceCodePro-Regular.otf b/...ssets/fonts/OTF/SourceCodePro-Regular.otf → ...ssets/fonts/OTF/SourceCodePro-Regular.otf
diff --git a/...i/assets/fonts/TTF/SourceCodePro-Bold.ttf → docs/assets/fonts/TTF/SourceCodePro-Bold.ttf b/...i/assets/fonts/TTF/SourceCodePro-Bold.ttf → docs/assets/fonts/TTF/SourceCodePro-Bold.ttf
diff --git a/...ssets/fonts/TTF/SourceCodePro-Regular.ttf → ...ssets/fonts/TTF/SourceCodePro-Regular.ttf b/...ssets/fonts/TTF/SourceCodePro-Regular.ttf → ...ssets/fonts/TTF/SourceCodePro-Regular.ttf
diff --git a/...onts/WOFF/OTF/SourceCodePro-Bold.otf.woff → ...onts/WOFF/OTF/SourceCodePro-Bold.otf.woff b/...onts/WOFF/OTF/SourceCodePro-Bold.otf.woff → ...onts/WOFF/OTF/SourceCodePro-Bold.otf.woff
diff --git a/...s/WOFF/OTF/SourceCodePro-Regular.otf.woff → ...s/WOFF/OTF/SourceCodePro-Regular.otf.woff b/...s/WOFF/OTF/SourceCodePro-Regular.otf.woff → ...s/WOFF/OTF/SourceCodePro-Regular.otf.woff
diff --git a/...onts/WOFF/TTF/SourceCodePro-Bold.ttf.woff → ...onts/WOFF/TTF/SourceCodePro-Bold.ttf.woff b/...onts/WOFF/TTF/SourceCodePro-Bold.ttf.woff → ...onts/WOFF/TTF/SourceCodePro-Bold.ttf.woff
diff --git a/...s/WOFF/TTF/SourceCodePro-Regular.ttf.woff → ...s/WOFF/TTF/SourceCodePro-Regular.ttf.woff b/...s/WOFF/TTF/SourceCodePro-Regular.ttf.woff → ...s/WOFF/TTF/SourceCodePro-Regular.ttf.woff
diff --git a/...ts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 → ...ts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 b/...ts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2 → ...ts/WOFF2/OTF/SourceCodePro-Bold.otf.woff2
diff --git a/...WOFF2/OTF/SourceCodePro-Regular.otf.woff2 → ...WOFF2/OTF/SourceCodePro-Regular.otf.woff2 b/...WOFF2/OTF/SourceCodePro-Regular.otf.woff2 → ...WOFF2/OTF/SourceCodePro-Regular.otf.woff2
diff --git a/...ts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 → ...ts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 b/...ts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2 → ...ts/WOFF2/TTF/SourceCodePro-Bold.ttf.woff2
diff --git a/...WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 → ...WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 b/...WOFF2/TTF/SourceCodePro-Regular.ttf.woff2 → ...WOFF2/TTF/SourceCodePro-Regular.ttf.woff2
diff --git a/docs/api/assets/fonts/source-code-pro.css → docs/assets/fonts/source-code-pro.css b/docs/api/assets/fonts/source-code-pro.css → docs/assets/fonts/source-code-pro.css
diff --git a/docs/api/assets/github.css → docs/assets/github.css b/docs/api/assets/github.css → docs/assets/github.css
diff --git a/docs/api/assets/site.js → docs/assets/site.js b/docs/api/assets/site.js → docs/assets/site.js
diff --git a/docs/api/assets/split.css → docs/assets/split.css b/docs/api/assets/split.css → docs/assets/split.css
diff --git a/docs/api/assets/split.js → docs/assets/split.js b/docs/api/assets/split.js → docs/assets/split.js
diff --git a/docs/api/assets/style.css → docs/assets/style.css b/docs/api/assets/style.css → docs/assets/style.css
diff --git a/docs/api/config.yml → docs/config.yml b/docs/api/config.yml → docs/config.yml
diff --git a/docs/api/index.html → docs/index.html b/docs/api/index.html → docs/index.html
diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
     "simulation-server": "bin/simulation-server.js"
   },
   "scripts": {
-    "doc": "documentation build -f html -o docs/api/ --github --config docs/api/config.yml"
+    "doc": "documentation build -f html -o docs/ --github --config docs/config.yml"
   },
   "repository": {
     "type": "git",

diff --git a/src/index.js b/src/index.js
@@ -65,7 +65,7 @@ const defaultLogCallback = entry => console.error(JSON.stringify(entry));
  * either one of the standard classes of GenIRSim or one in `additionalSystems`
  * @param {number} [configuration.maxTurns] - The maximum number of user turns
  * to simulate (default: 3)
- * @param {Object} [options] -
+ * @param {Object} [options]
  * @param {function} [options.logCallback] - The function to consume all
  * {@link LogbookEntry} of the simulation
  * @param {Object} [options.additionalUsers] - Object that contains non-standard
@@ -155,7 +155,7 @@ async function evaluateTurn(instantiatedEvaluators, logbook, simulation, userTur
  * in the the constructor and (2) has a property `class` that is the name of the
  * evaluator class, either one of the standard classes of GenIRSim or one in
  * `additionalEvaluators`
- * @param {Object} [options] -
+ * @param {Object} [options]
  * @param {function} [options.logCallback] - The function to consume all
  * {@link LogbookEntry} of the evaluation
  * @param {Object} [options.additionalEvaluators] - Object that contains
@@ -211,7 +211,7 @@ export async function evaluate(simulation, configuration, options = undefined) {
  * simulation, see {@link simulate}
  * @param {Object} configuration.evaluation - The configuration for the
  * evaluation, see {@link evaluate}
- * @param {Object} [options] -
+ * @param {Object} [options]
  * @param {function} [options.logCallback] - The function to consume all
  * {@link LogbookEntry} of the simulation and evaluation
  * @param {Object} [options.additionalUsers] - Object that contains non-standard {User}