Added documentation

StatMixedML · Aug 9, 2023 · 47a50b1 · 47a50b1
1 parent ca09ca4
commit 47a50b1
Show file tree

Hide file tree

Showing 4 changed files with 22 additions and 0 deletions.
diff --git a/.github/workflows/mkdocs.yaml b/.github/workflows/mkdocs.yaml
@@ -0,0 +1,17 @@
+name: mkdocs
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+  workflow_dispatch:
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material mkdocstrings[python] mkdocs-jupyter
+      - run: mkdocs gh-deploy --force
diff --git a/docs/examples b/docs/examples
@@ -0,0 +1 @@
+../examples
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1 @@
+../README.md
diff --git a/docs/references.md b/docs/references.md
@@ -0,0 +1,3 @@
+# API references
+
+::: xgboostlss