diff --git a/build.gradle b/build.gradle
index 5dad4016..c256fc19 100644
--- a/build.gradle
+++ b/build.gradle
@@ -1,3 +1,17 @@
+buildscript {
+ repositories {
+ jcenter()
+ maven {
+ url "https://plugins.gradle.org/m2/"
+ }
+ mavenCentral()
+ }
+
+ dependencies {
+ classpath "org.asciidoctor:asciidoctor-gradle-jvm:3.3.2"
+ }
+}
+
plugins {
id 'java'
id 'application'
@@ -121,3 +135,28 @@ configurations.all {
jacocoTestReport {
dependsOn test // tests are required to run before generating the report
}
+
+project.ext {
+ mainClassName = "io.seqera.tower.cli.Tower"
+}
+
+task generateManpageAsciiDoc(type: JavaExec) {
+ dependsOn(classes)
+ group = "Documentation"
+ description = "Generate AsciiDoc manpage"
+ classpath(configurations.compileClasspath, configurations.annotationProcessor, sourceSets.main.runtimeClasspath)
+ main 'picocli.codegen.docgen.manpage.ManPageGenerator'
+ args project.ext.mainClassName, "--outdir=${project.buildDir}/generated-picocli-docs", "-v"
+}
+
+apply plugin: 'org.asciidoctor.jvm.convert'
+asciidoctor {
+ dependsOn(generateManpageAsciiDoc)
+ sourceDir = file("${project.buildDir}/generated-picocli-docs")
+ outputDir = file("${project.buildDir}/generated-picocli-docs-xml")
+ logDocuments = true
+ outputOptions {
+ backends = ['docbook']
+ }
+}
+
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 00000000..aad11e15
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,10 @@
+SHELL := /bin/bash
+
+DOCKER ?= squidfunk/mkdocs-material:7.1.2
+
+build:
+ ./build.sh
+ docker run --rm -it -p 8000:8000 -u $(shell id -u) -v ${PWD}/../build:/docs $(DOCKER) build
+
+serve:
+ docker run --rm -it -p 8000:8000 -u $(shell id -u) -v ${PWD}/../build:/docs $(DOCKER)
diff --git a/docs/build.sh b/docs/build.sh
new file mode 100755
index 00000000..e98b0e8a
--- /dev/null
+++ b/docs/build.sh
@@ -0,0 +1,11 @@
+#!/usr/bin/env bash
+
+cd ..
+./gradlew asciidoctor
+mkdir -p build/docs
+cd build/generated-picocli-docs-xml
+ls *.xml | awk '{system("pandoc -f docbook -t markdown_strict "$1" -o ../docs/"$1".md")}'
+cd ../docs
+ls *.md | awk '{system("sed -i 's/\.xml/\.xml\.md/g' "$1)}'
+cd ..
+cp -r ../docs/* .
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
new file mode 100644
index 00000000..6596b6c1
--- /dev/null
+++ b/docs/mkdocs.yml
@@ -0,0 +1,127 @@
+site_name: 'Tower CLI command line reference'
+site_author: Seqera Labs
+repo_name: tower-cli
+repo_url: https://github.com/seqeralabs/tower-cli
+
+site_dir: public
+
+plugins:
+ - search
+
+theme:
+ language: en
+ name: material
+ custom_dir: overrides
+ palette:
+ scheme: default
+ primary: white
+ favicon: _favicons/favicon.ico
+ logo: _logos/nf-tower-icon-black.svg
+ features:
+ - navigation.instant
+ - navigation.tracking
+ - navigation.top
+ - search.suggest
+ - search.highlight
+ - search.share
+ font: false
+ icon:
+ admonition:
+ note: fontawesome/solid/sticky-note
+ abstract: fontawesome/solid/book
+ info: fontawesome/solid/info-circle
+ tip: fontawesome/solid/bullhorn
+ success: fontawesome/solid/check
+ question: fontawesome/solid/question-circle
+ warning: fontawesome/solid/exclamation-triangle
+ failure: fontawesome/solid/bomb
+ danger: fontawesome/solid/skull
+ bug: fontawesome/solid/robot
+ example: fontawesome/solid/flask
+ quote: fontawesome/solid/quote-left
+
+extra_css:
+ - stylesheets/fonts.css
+ - stylesheets/overrides.css
+ - stylesheets/extra.css # 2022-04-01 Added by Graham to get more space above bullets.
+
+
+extra:
+ homepage: /
+ version:
+ provider: mike
+
+markdown_extensions:
+ - toc:
+ permalink: "#"
+ - attr_list
+ - admonition
+ - pymdownx.superfences
+ - pymdownx.highlight:
+ linenums: true
+ - pymdownx.snippets
+ - pymdownx.emoji:
+ emoji_index: !!python/name:materialx.emoji.twemoji
+ emoji_generator: !!python/name:materialx.emoji.to_svg
+
+nav:
+ - 'Home': 'tw.xml.md'
+ - 'Actions':
+ - 'Add':
+ - 'Github': 'tw-actions-add-github.xml.md'
+ - 'Tower': 'tw-actions-add-tower.xml.md'
+ - 'Core Concepts': 'core-concepts/definitions.md'
+ - 'Users & Workspaces':
+ - 'Overview': 'orgs-and-teams/overview.md'
+ - 'Organizations': 'orgs-and-teams/organizations.md'
+ - 'Workspace Management': 'orgs-and-teams/workspace-management.md'
+ - 'Shared Workspaces' : 'orgs-and-teams/shared-workspaces.md'
+ - 'Launching Pipelines':
+ - 'Launchpad': 'launch/launchpad.md'
+ - 'Launch Form': 'launch/launch.md'
+ - 'Advanced Options': 'launch/advanced.md'
+ - 'Relaunch': 'launch/relaunch.md'
+ - 'Notifications': 'launch/notifications.md'
+ - 'Monitoring Pipelines':
+ - 'Overview': 'monitoring/overview.md'
+ - 'Execution details & logs': 'monitoring/execution.md'
+ - 'Summary & status': 'monitoring/summary.md'
+ - 'Processes': 'monitoring/processes.md'
+ - 'Aggregate stats & load': 'monitoring/aggregate_stats.md'
+ - 'Tasks & metrics': 'monitoring/tasks.md'
+ # - 'Sharing pipelines': 'monitoring/sharing.md'
+ - 'Compute Environments':
+ - 'Overview': 'compute-envs/overview.md'
+ - 'AWS Batch': 'compute-envs/aws-batch.md'
+ - 'Azure Batch': 'compute-envs/azure-batch.md'
+ - 'Google Cloud Life Sciences': 'compute-envs/google-cloud.md'
+ - 'Altair Grid Engine': 'compute-envs/altair-grid-engine.md'
+ - 'Altair PBS Pro': 'compute-envs/altair-pbs-pro.md'
+ - 'IBM LSF': 'compute-envs/lsf.md'
+ - 'Slurm': 'compute-envs/slurm.md'
+ - 'Kubernetes': 'compute-envs/k8s.md'
+ - 'Amazon EKS': 'compute-envs/eks.md'
+ - 'Google GKE': 'compute-envs/gke.md'
+ - 'Credentials':
+ - 'Overview': 'credentials/overview.md'
+ - 'Datasets': 'datasets/overview.md'
+ - 'Pipeline Secrets': 'secrets/overview.md'
+ - 'Pipeline Reports': 'reports/overview.md'
+ - 'Git Integration':
+ - 'Overview': 'git/overview.md'
+ - 'Private Git repositories': 'git/private_repositories.md'
+ - 'Public Git repositories': 'git/public_repositories.md'
+ - 'Automation':
+ - 'Pipeline Actions': 'pipeline-actions/pipeline-actions.md'
+ - 'Pipeline Schema': 'pipeline-schema/overview.md'
+ - 'Installation':
+ - 'System deployment': 'installation/system-deployment.md'
+ - 'CLI': 'cli.md'
+ - 'API':
+ - 'Overview': 'api/overview.md'
+ - 'Endpoints': 'api/endpoints.md'
+ - 'OpenAPI schema': 'api/openapi.md'
+ #- 'Functionality Matrix': 'functionality_matrix.md'
+ - 'Frequently asked questions' : faqs.md
+
+copyright: Copyright © 2019 - 2022 Seqera Labs, S.L.
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.eot b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.eot
new file mode 100644
index 00000000..df3455ad
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.eot differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.svg b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.svg
new file mode 100644
index 00000000..cc290b78
--- /dev/null
+++ b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.svg
@@ -0,0 +1,23184 @@
+
+
+
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.ttf b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.ttf
new file mode 100644
index 00000000..5d047ece
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.ttf differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.woff b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.woff
new file mode 100644
index 00000000..ad6be92a
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.woff differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.woff2 b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.woff2
new file mode 100644
index 00000000..415cbb26
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Bold.woff2 differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.eot b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.eot
new file mode 100644
index 00000000..53d33384
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.eot differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.svg b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.svg
new file mode 100644
index 00000000..a9fb403d
--- /dev/null
+++ b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.svg
@@ -0,0 +1,23115 @@
+
+
+
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.ttf b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.ttf
new file mode 100644
index 00000000..00c7c500
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.ttf differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.woff b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.woff
new file mode 100644
index 00000000..9c9b143f
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.woff differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.woff2 b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.woff2
new file mode 100644
index 00000000..90517247
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.woff2 differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.eot b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.eot
new file mode 100644
index 00000000..dc1b0891
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.eot differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.svg b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.svg
new file mode 100644
index 00000000..18940307
--- /dev/null
+++ b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.svg
@@ -0,0 +1,22080 @@
+
+
+
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.ttf b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.ttf
new file mode 100644
index 00000000..41c5aa2a
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.ttf differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.woff b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.woff
new file mode 100644
index 00000000..265bb6bd
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.woff differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.woff2 b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.woff2
new file mode 100644
index 00000000..413b6e3c
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Light.woff2 differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.eot b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.eot
new file mode 100644
index 00000000..b6724e40
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.eot differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.svg b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.svg
new file mode 100644
index 00000000..7c1ac40a
--- /dev/null
+++ b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.svg
@@ -0,0 +1,22663 @@
+
+
+
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.ttf b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.ttf
new file mode 100644
index 00000000..afeebec4
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.ttf differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.woff b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.woff
new file mode 100644
index 00000000..d9c4fa3b
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.woff differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.woff2 b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.woff2
new file mode 100644
index 00000000..68c018ff
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Medium.woff2 differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.eot b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.eot
new file mode 100644
index 00000000..fb7f86af
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.eot differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.svg b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.svg
new file mode 100644
index 00000000..e6f68aa0
--- /dev/null
+++ b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.svg
@@ -0,0 +1,23222 @@
+
+
+
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.ttf b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.ttf
new file mode 100644
index 00000000..b5a7a720
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.ttf differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.woff b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.woff
new file mode 100644
index 00000000..05350023
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.woff differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.woff2 b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.woff2
new file mode 100644
index 00000000..c192e434
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.woff2 differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.eot b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.eot
new file mode 100644
index 00000000..d1263a31
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.eot differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.svg b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.svg
new file mode 100644
index 00000000..f53e18a4
--- /dev/null
+++ b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.svg
@@ -0,0 +1,22202 @@
+
+
+
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.ttf b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.ttf
new file mode 100644
index 00000000..bf046940
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.ttf differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.woff b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.woff
new file mode 100644
index 00000000..7354d5f7
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.woff differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.woff2 b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.woff2
new file mode 100644
index 00000000..60cee828
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Thin.woff2 differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.eot b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.eot
new file mode 100644
index 00000000..675f3bb2
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.eot differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.svg b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.svg
new file mode 100644
index 00000000..b8a29fe3
--- /dev/null
+++ b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.svg
@@ -0,0 +1,20927 @@
+
+
+
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.ttf b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.ttf
new file mode 100644
index 00000000..b04d963c
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.ttf differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.woff b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.woff
new file mode 100644
index 00000000..3157e865
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.woff differ
diff --git a/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.woff2 b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.woff2
new file mode 100644
index 00000000..2fd52696
Binary files /dev/null and b/docs/overrides/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.woff2 differ
diff --git a/docs/overrides/assets/stylesheets/fonts.css b/docs/overrides/assets/stylesheets/fonts.css
new file mode 100644
index 00000000..aa3e130e
--- /dev/null
+++ b/docs/overrides/assets/stylesheets/fonts.css
@@ -0,0 +1,87 @@
+@font-face {
+ font-family: 'SF UI Display';
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.eot');
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.eot?#iefix') format('embedded-opentype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.svg#SFUIDisplay-Ultralight') format('svg'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.ttf') format('truetype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.woff') format('woff'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Ultralight.woff2') format('woff2');
+ font-weight: 100;
+ font-style: normal;
+}
+
+@font-face {
+ font-family: 'SF UI Display';
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Thin.eot');
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Thin.eot?#iefix') format('embedded-opentype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Thin.svg#SFUIDisplay-Thin') format('svg'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Thin.ttf') format('truetype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Thin.woff') format('woff'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Thin.woff2') format('woff2');
+ font-weight: 200;
+ font-style: normal;
+}
+
+@font-face {
+ font-family: 'SF UI Display';
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Light.eot');
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Light.eot?#iefix') format('embedded-opentype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Light.svg#SFUIDisplay-Light') format('svg'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Light.ttf') format('truetype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Light.woff') format('woff'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Light.woff2') format('woff2');
+ font-weight: 300;
+ font-style: normal;
+}
+
+@font-face {
+ font-family: 'SF UI Display';
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Medium.eot');
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Medium.eot?#iefix') format('embedded-opentype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Medium.svg#SFUIDisplay-Medium') format('svg'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Medium.ttf') format('truetype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Medium.woff') format('woff'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Medium.woff2') format('woff2');
+ font-weight: 400;
+ font-style: normal;
+}
+
+@font-face {
+ font-family: 'SF UI Display';
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.eot');
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.eot?#iefix') format('embedded-opentype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.svg#SFUIDisplay-Semibold') format('svg'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.ttf') format('truetype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Semibold.woff') format('woff'),
+ url('/assets/SFUIDisplay-Semibold.woff2') format('woff2');
+ font-weight: 500;
+ font-style: normal;
+}
+
+@font-face {
+ font-family: 'SF UI Display';
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Bold.eot');
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Bold.eot?#iefix') format('embedded-opentype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Bold.svg#SFUIDisplay-Bold') format('svg'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Bold.ttf') format('truetype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Bold.woff') format('woff'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Bold.woff2') format('woff2');
+ font-weight: 600;
+ font-style: normal;
+}
+
+@font-face {
+ font-family: 'SF UI Display';
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.eot');
+ src: url('/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.eot?#iefix') format('embedded-opentype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.svg#SFUIDisplay-Heavy') format('svg'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.ttf') format('truetype'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.woff') format('woff'),
+ url('/assets/fonts/sf-ui-display/SFUIDisplay-Heavy.woff2') format('woff2');
+ font-weight: 700;
+ font-style: normal;
+}
+
+:root {
+ --md-text-font-family: "SF UI Display";
+}
diff --git a/docs/overrides/assets/stylesheets/overrides.css b/docs/overrides/assets/stylesheets/overrides.css
new file mode 100644
index 00000000..445383bd
--- /dev/null
+++ b/docs/overrides/assets/stylesheets/overrides.css
@@ -0,0 +1,54 @@
+strong {
+ font-weight: 600;
+}
+
+.md-typeset h1, .md-typeset h2 {
+ font-weight: 600;
+ color: #000;
+}
+
+.md-typeset p {
+ font-size: 18px;
+ font-weight: 300;
+ line-height: 32px;
+}
+
+.md-typeset li {
+ font-size: 18px;
+ font-weight: 300;
+ line-height: 32px;
+}
+
+.md-nav__title {
+ color: #676767;
+ font-size: 16px;
+ font-weight: 600;
+}
+
+.md-nav__link {
+ font-size: 16px;
+ font-weight: 300;
+ margin-top: 15px;
+}
+
+.md-nav__item .md-nav__link--active {
+ font-weight: 600;
+}
+
+.md-header__topic {
+ font-weight: 600;
+}
+
+.md-search,
+.md-search__input {
+ font-weight: 300;
+}
+
+.md-typeset .admonition-title,
+.md-typeset summary {
+ align-items: center;
+ display: flex;
+ flex-wrap: nowrap;
+ font-size: 16px;
+ font-weight: 600;
+}
diff --git a/docs/overrides/main.html b/docs/overrides/main.html
new file mode 100644
index 00000000..b23b6553
--- /dev/null
+++ b/docs/overrides/main.html
@@ -0,0 +1,8 @@
+{% extends "base.html" %}
+
+{% block outdated %}
+ You're not viewing the latest version.
+
+ Click here to go to latest.
+
+ {% endblock %}
diff --git a/docs/overrides/partials/base.html b/docs/overrides/partials/base.html
new file mode 100644
index 00000000..b1649f28
--- /dev/null
+++ b/docs/overrides/partials/base.html
@@ -0,0 +1,11 @@
+{% extends "base.html" %}
+
+{% block analytics %}
+
+
+{% endblock %}
diff --git a/docs/overrides/partials/footer.html b/docs/overrides/partials/footer.html
new file mode 100644
index 00000000..9c278e7f
--- /dev/null
+++ b/docs/overrides/partials/footer.html
@@ -0,0 +1,47 @@
+
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 00000000..d8a553f7
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,109 @@
+argon2-cffi==21.1.0
+astroid==2.7.3
+attrs==21.2.0
+autopep8==1.5.7
+backcall==0.2.0
+backports.entry-points-selectable==1.1.0
+bandit==1.7.0
+bleach==4.1.0
+certifi==2021.5.30
+cffi==1.14.6
+charset-normalizer==2.0.4
+click==8.0.3
+colorama==0.4.4
+cryptography==3.4.8
+debugpy==1.4.3
+decorator==5.1.0
+defusedxml==0.7.1
+distlib==0.3.2
+docutils==0.17.1
+entrypoints==0.3
+filelock==3.0.12
+flake8==3.9.2
+ghp-import==2.0.2
+gitdb==4.0.7
+GitPython==3.1.18
+idna==3.2
+importlib-metadata==4.8.1
+ipykernel==6.4.1
+ipython==7.31.1
+ipython-genutils==0.2.0
+isort==5.9.3
+jedi==0.18.0
+jeepney==0.7.1
+Jinja2==3.0.1
+jsonschema==3.2.0
+jupyter-client==7.0.2
+jupyter-core==4.7.1
+jupyterlab-pygments==0.1.2
+keyring==23.2.1
+lazy-object-proxy==1.6.0
+Markdown==3.3.6
+MarkupSafe==2.0.1
+matplotlib-inline==0.1.3
+mccabe==0.6.1
+mergedeep==1.3.4
+mike==1.1.2
+mistune==0.8.4
+mkdocs==1.2.3
+mypy==0.910
+mypy-extensions==0.4.3
+nbclient==0.5.4
+nbconvert==6.1.0
+nbformat==5.1.3
+nest-asyncio==1.5.1
+notebook==6.4.3
+packaging==21.0
+pandocfilters==1.4.3
+parso==0.8.2
+pbr==5.6.0
+pep8==1.7.1
+pexpect==4.8.0
+pickleshare==0.7.5
+pipenv==2022.1.8
+pkginfo==1.7.1
+platformdirs==2.3.0
+prometheus-client==0.11.0
+prompt-toolkit==3.0.20
+ptyprocess==0.7.0
+pycodestyle==2.7.0
+pycparser==2.20
+pydocstyle==6.1.1
+pyflakes==2.3.1
+Pygments==2.12.0
+pylama==7.7.1
+pylint==2.10.2
+pyparsing==2.4.7
+pyrsistent==0.18.0
+python-dateutil==2.8.2
+PyYAML==5.4.1
+pyyaml_env_tag==0.1
+pyzmq==22.2.1
+readme-renderer==29.0
+requests==2.26.0
+requests-toolbelt==0.9.1
+rfc3986==1.5.0
+rope==0.19.0
+SecretStorage==3.3.1
+Send2Trash==1.8.0
+six==1.16.0
+smmap==4.0.0
+snowballstemmer==2.1.0
+stevedore==3.4.0
+terminado==0.12.1
+testpath==0.5.0
+toml==0.10.2
+tornado==6.1
+tqdm==4.62.2
+traitlets==5.1.0
+twine==3.4.2
+typing-extensions==3.10.0.2
+urllib3==1.26.6
+verspec==0.1.0
+virtualenv==20.7.2
+virtualenv-clone==0.5.7
+watchdog==2.1.6
+wcwidth==0.2.5
+webencodings==0.5.1
+wrapt==1.12.1
+zipp==3.5.0