website integration

.github/workflows/build_site.yml

@@ -0,0 +1,31 @@
+name: Publish docs via GitHub Pages
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release' && github.event.action == 'published'
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v2
+
+      - name: Build wheels
+        shell: bash -l {0}
+        run: |
+          bash docs/create_docs.sh
+
+      # NOT SURE HOW TO AUTOMATE VERSIONING, RUNNING THIS WILL WIPE EVERYTHING
+      # - name: Deploy docs
+      #   uses: mhausenblas/mkdocs-deploy-gh-pages@master
+      #   # Or use mhausenblas/mkdocs-deploy-gh-pages@nomaterial to build without the mkdocs-material theme
+      #   env:
+      #     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      #     # CUSTOM_DOMAIN: optionaldomain.com
+      #     CONFIG_FILE: mkdocs.yml
+      #     # EXTRA_PACKAGES: mkdocstrings
+      #     # GITHUB_DOMAIN: github.myenterprise.com
+      #     REQUIREMENTS: docs/requirements.txt

.gitignore

@@ -21,4 +21,7 @@ src/fast_cd/examples/__pycache__/*
 src/fast_cd/apps/__pycache__/*
 
 results/**
-**.ini
+**.ini
+
+site/*
+site/**

docs/apps/animate_rig.md

@@ -0,0 +1,5 @@
+---
+title: "apps.animate_rig"
+---
+
+::: src.fast_cd.apps.animate_rig

docs/apps/cd_demo_pose_tracker.md

@@ -0,0 +1,5 @@
+---
+title: "apps.cd_demo_pose_tracker"
+---
+
+::: src.fast_cd.apps.cd_demo_pose_tracker

docs/apps/interactive_cd_affine_handle.md

@@ -0,0 +1,5 @@
+---
+title: "apps.interactive_cd_affine_handle"
+---
+
+::: src.fast_cd.apps.interactive_cd_affine_handle

docs/apps/interactive_cd_face_tracking.md

@@ -0,0 +1,5 @@
+---
+title: "apps.interactive_cd_face_tracking"
+---
+
+::: src.fast_cd.apps.interactive_cd_face_tracking

docs/apps/interactive_cd_rig_anim.md

@@ -0,0 +1,5 @@
+---
+title: "apps.interactive_cd_rig_anim"
+---
+
+::: src.fast_cd.apps.interactive_cd_rig_anim

docs/apps/test_FAST_IK.md

@@ -0,0 +1,5 @@
+---
+title: "apps.test_FAST_IK"
+---
+
+::: src.fast_cd.apps.test_FAST_IK

docs/apps/test_FAST_IK_CD_tex.md

@@ -0,0 +1,5 @@
+---
+title: "apps.test_FAST_IK_CD_tex"
+---
+
+::: src.fast_cd.apps.test_FAST_IK_CD_tex

docs/apps/test_FAST_IK_tex.md

@@ -0,0 +1,5 @@
+---
+title: "apps.test_FAST_IK_tex"
+---
+
+::: src.fast_cd.apps.test_FAST_IK_tex

docs/arap_hessian.md

@@ -0,0 +1,5 @@
+---
+title: "arap_hessian"
+---
+
+::: src.fast_cd.arap_hessian

docs/average_onto_simplex.md

@@ -0,0 +1,5 @@
+---
+title: "average_onto_simplex"
+---
+
+::: src.fast_cd.average_onto_simplex

docs/closest_orthogonal_subspace.md

@@ -0,0 +1,5 @@
+---
+title: "closest_orthogonal_subspace"
+---
+
+::: src.fast_cd.closest_orthogonal_subspace

docs/cluster_centroids.md

@@ -0,0 +1,5 @@
+---
+title: "cluster_centroids"
+---
+
+::: src.fast_cd.cluster_centroids

docs/cluster_grouping_matrices.md

@@ -0,0 +1,5 @@
+---
+title: "cluster_grouping_matrices"
+---
+
+::: src.fast_cd.cluster_grouping_matrices

docs/complementary_constraint_matrix.md

@@ -0,0 +1,5 @@
+---
+title: "complementary_constraint_matrix"
+---
+
+::: src.fast_cd.complementary_constraint_matrix

docs/create_docs.sh

@@ -0,0 +1,45 @@
+#!/bin/bash
+#Delete everything in docs except for index.md
+shopt -s nullglob
+for file in docs/*.md; do
+	name=$(basename "$file")
+	if ! [ "$name" = "index.md" ]; then
+		rm "$file"
+	fi
+done
+#Delete everything in docs subdirectories except for index.md
+shopt -s nullglob
+for file in docs/*/*.md; do
+	name=$(basename "$file")
+	if ! [ "$name" = "index.md" ]; then
+		rm "$file"
+	fi
+done
+#For all files not in a module
+shopt -s nullglob
+for file in src/fast_cd/*.py; do
+	name=$(basename "$file" .py)
+	if ! [ "$name" = "__init__" ]; then
+		path="docs/${name}.md"
+		echo "---" > $path
+		echo "title: \"${name}\"" >> $path
+		echo "---" >> $path
+		echo >> $path
+		echo "::: src.fast_cd.${name}" >> $path
+	fi
+done
+#For all files in a module
+shopt -s nullglob
+for file in src/fast_cd/*/*.py; do
+	name=$(basename "$file" .py)
+	modulename=$(basename "$(dirname $file)")
+	if ! [ "$name" = "__init__" ]; then
+		mkdir -p "docs/${modulename}"
+		path="docs/${modulename}/${name}.md"
+		echo "---" > $path
+		echo "title: \"${modulename}.${name}\"" >> $path
+		echo "---" >> $path
+		echo >> $path
+		echo "::: src.fast_cd.${modulename}.${name}" >> $path
+	fi
+done

docs/deformation_jacobian.md

@@ -0,0 +1,5 @@
+---
+title: "deformation_jacobian"
+---
+
+::: src.fast_cd.deformation_jacobian

docs/diffuse_weights.md

@@ -0,0 +1,5 @@
+---
+title: "diffuse_weights"
+---
+
+::: src.fast_cd.diffuse_weights

docs/eigs.md

@@ -0,0 +1,5 @@
+---
+title: "eigs"
+---
+
+::: src.fast_cd.eigs

docs/face_landmarks_to_positions.md

@@ -0,0 +1,5 @@
+---
+title: "face_landmarks_to_positions"
+---
+
+::: src.fast_cd.face_landmarks_to_positions

docs/fast_cd_sim.md

@@ -0,0 +1,5 @@
+---
+title: "fast_cd_sim"
+---
+
+::: src.fast_cd.fast_cd_sim

docs/index.md

@@ -0,0 +1,6 @@
+# Fast Complementary Dynamics
+
+This is the documentation page for the source code for [Fast Complementary Dynamics
+via Skinning Eigenmodes](https://www.dgp.toronto.edu/projects/fast_complementary_dynamics_site/).
+
+This site and codebase is still a work in progress.

docs/laplacian.md

@@ -0,0 +1,5 @@
+---
+title: "laplacian"
+---
+
+::: src.fast_cd.laplacian

docs/laplacian_eigenmodes.md

@@ -0,0 +1,5 @@
+---
+title: "laplacian_eigenmodes"
+---
+
+::: src.fast_cd.laplacian_eigenmodes

docs/lbs_jacobian.md

@@ -0,0 +1,5 @@
+---
+title: "lbs_jacobian"
+---
+
+::: src.fast_cd.lbs_jacobian

docs/lbs_weight_space_constraint.md

@@ -0,0 +1,5 @@
+---
+title: "lbs_weight_space_constraint"
+---
+
+::: src.fast_cd.lbs_weight_space_constraint

docs/linear_elasticity_hessian.md

@@ -0,0 +1,5 @@
+---
+title: "linear_elasticity_hessian"
+---
+
+::: src.fast_cd.linear_elasticity_hessian

docs/mediapipe_face.md

@@ -0,0 +1,5 @@
+---
+title: "mediapipe_face"
+---
+
+::: src.fast_cd.mediapipe_face

docs/mediapipe_face_captor.md

@@ -0,0 +1,5 @@
+---
+title: "mediapipe_face_captor"
+---
+
+::: src.fast_cd.mediapipe_face_captor

docs/momentum_leaking_matrix.md

@@ -0,0 +1,5 @@
+---
+title: "momentum_leaking_matrix"
+---
+
+::: src.fast_cd.momentum_leaking_matrix

docs/normalize_height_and_center.md

@@ -0,0 +1,5 @@
+---
+title: "normalize_height_and_center"
+---
+
+::: src.fast_cd.normalize_height_and_center

docs/one_euro_filter.md

@@ -0,0 +1,5 @@
+---
+title: "one_euro_filter"
+---
+
+::: src.fast_cd.one_euro_filter

docs/orthonormalize.md

@@ -0,0 +1,5 @@
+---
+title: "orthonormalize"
+---
+
+::: src.fast_cd.orthonormalize

docs/project_into_subspace.md

@@ -0,0 +1,5 @@
+---
+title: "project_into_subspace"
+---
+
+::: src.fast_cd.project_into_subspace

docs/project_out_subspace.md

@@ -0,0 +1,5 @@
+---
+title: "project_out_subspace"
+---
+
+::: src.fast_cd.project_out_subspace

docs/project_to_orthogonal.md

@@ -0,0 +1,5 @@
+---
+title: "project_to_orthogonal"
+---
+
+::: src.fast_cd.project_to_orthogonal

docs/read_rig_anim_from_json.md

@@ -0,0 +1,5 @@
+---
+title: "read_rig_anim_from_json"
+---
+
+::: src.fast_cd.read_rig_anim_from_json

docs/read_rig_from_json.md

@@ -0,0 +1,5 @@
+---
+title: "read_rig_from_json"
+---
+
+::: src.fast_cd.read_rig_from_json

docs/rig_curve_geometry.md

@@ -0,0 +1,5 @@
+---
+title: "rig_curve_geometry"
+---
+
+::: src.fast_cd.rig_curve_geometry

docs/rig_geometry.md

@@ -0,0 +1,5 @@
+---
+title: "rig_geometry"
+---
+
+::: src.fast_cd.rig_geometry

docs/rotate_rig.md

@@ -0,0 +1,5 @@
+---
+title: "rotate_rig"
+---
+
+::: src.fast_cd.rotate_rig

docs/skinning_clusters.md

@@ -0,0 +1,5 @@
+---
+title: "skinning_clusters"
+---
+
+::: src.fast_cd.skinning_clusters

docs/skinning_subspace.md

@@ -0,0 +1,5 @@
+---
+title: "skinning_subspace"
+---
+
+::: src.fast_cd.skinning_subspace

docs/umfpack_lu_solve.md

@@ -0,0 +1,5 @@
+---
+title: "umfpack_lu_solve"
+---
+
+::: src.fast_cd.umfpack_lu_solve

docs/vectorized_trace.md

@@ -0,0 +1,5 @@
+---
+title: "vectorized_trace"
+---
+
+::: src.fast_cd.vectorized_trace

docs/vectorized_transpose.md

@@ -0,0 +1,5 @@
+---
+title: "vectorized_transpose"
+---
+
+::: src.fast_cd.vectorized_transpose

docs/viewers/ClustersViewer.md

@@ -0,0 +1,5 @@
+---
+title: "viewers.ClustersViewer"
+---
+
+::: src.fast_cd.viewers.ClustersViewer

docs/viewers/WeightsViewer.md

@@ -0,0 +1,5 @@
+---
+title: "viewers.WeightsViewer"
+---
+
+::: src.fast_cd.viewers.WeightsViewer

docs/viewers/interactive_handle_subspace_viewer.md

@@ -0,0 +1,5 @@
+---
+title: "viewers.interactive_handle_subspace_viewer"
+---
+
+::: src.fast_cd.viewers.interactive_handle_subspace_viewer

docs/viewers/interactive_handle_viewer.md

@@ -0,0 +1,5 @@
+---
+title: "viewers.interactive_handle_viewer"
+---
+
+::: src.fast_cd.viewers.interactive_handle_viewer

docs/world2rel.md

@@ -0,0 +1,5 @@
+---
+title: "world2rel"
+---
+
+::: src.fast_cd.world2rel

docs/ympr_to_lame.md

@@ -0,0 +1,5 @@
+---
+title: "ympr_to_lame"
+---
+
+::: src.fast_cd.ympr_to_lame