Merge branch 'docs' of https://github.com/EthoML/VAME into docs

.github/workflows/deploy-docs.yaml

@@ -39,6 +39,19 @@ jobs:
       - name: Build website
         run: cd docs/vame-docs-app && yarn build
 
+      - name: Commit pydoc-markdown files
+        run: |
+          git config --local user.email "github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+          GIT_STATUS=$(git status -s)
+          [[ ! -z "$GIT_STATUS" ]] && git add docs/* && git commit -m "auto-commit-docs" -a || echo "No changes to commit"
+
+      - name: Push changes
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}
+
       # Popular action to deploy to GitHub Pages:
       # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
       - name: Deploy to GitHub Pages

docs/vame-docs-app/docs/reference/_category_.json

@@ -0,0 +1,8 @@
+{
+    "label": "API reference",
+    "position": 3,
+    "link": {
+        "type": "generated-index",
+        "description": "VAME package API reference"
+    }
+}

docs/vame-docs-app/docs/reference/sidebar.json

@@ -0,0 +1,48 @@
+{
+  "items": [
+    {
+      "items": [
+        "reference/vame/analysis/community_analysis",
+        "reference/vame/analysis/generative_functions",
+        "reference/vame/analysis/gif_creator",
+        "reference/vame/analysis/pose_segmentation",
+        "reference/vame/analysis/segment_behavior",
+        "reference/vame/analysis/tree_hierarchy",
+        "reference/vame/analysis/umap_visualization",
+        "reference/vame/analysis/videowriter"
+      ],
+      "label": "vame.analysis",
+      "type": "category"
+    },
+    {
+      "items": [
+        "reference/vame/initialize_project/new"
+      ],
+      "label": "vame.initialize_project",
+      "type": "category"
+    },
+    {
+      "items": [
+        "reference/vame/model/create_training",
+        "reference/vame/model/dataloader",
+        "reference/vame/model/evaluate",
+        "reference/vame/model/rnn_model",
+        "reference/vame/model/rnn_vae"
+      ],
+      "label": "vame.model",
+      "type": "category"
+    },
+    {
+      "items": [
+        "reference/vame/util/align_egocentrical",
+        "reference/vame/util/auxiliary",
+        "reference/vame/util/csv_to_npy",
+        "reference/vame/util/gif_pose_helper"
+      ],
+      "label": "vame.util",
+      "type": "category"
+    }
+  ],
+  "label": "vame",
+  "type": "category"
+}