docs

docs/index.md

@@ -1 +1,44 @@
-# Beignet
+# beignet
+
+::: beignet.apply_euler_angle
+::: beignet.apply_quaternion
+::: beignet.apply_rotation_matrix
+::: beignet.apply_rotation_vector
+::: beignet.compose_euler_angle
+::: beignet.compose_quaternion
+::: beignet.compose_rotation_matrix
+::: beignet.compose_rotation_vector
+::: beignet.euler_angle_identity
+::: beignet.euler_angle_magnitude
+::: beignet.euler_angle_mean
+::: beignet.euler_angle_to_quaternion
+::: beignet.euler_angle_to_rotation_matrix
+::: beignet.euler_angle_to_rotation_vector
+::: beignet.invert_euler_angle
+::: beignet.invert_quaternion
+::: beignet.invert_rotation_matrix
+::: beignet.invert_rotation_vector
+::: beignet.quaternion_identity
+::: beignet.quaternion_magnitude
+::: beignet.quaternion_mean
+::: beignet.quaternion_slerp
+::: beignet.quaternion_to_euler_angle
+::: beignet.quaternion_to_rotation_matrix
+::: beignet.quaternion_to_rotation_vector
+::: beignet.random_euler_angle
+::: beignet.random_quaternion
+::: beignet.random_rotation_matrix
+::: beignet.random_rotation_vector
+::: beignet.rotation_matrix_identity
+::: beignet.rotation_matrix_magnitude
+::: beignet.rotation_matrix_mean
+::: beignet.rotation_matrix_to_euler_angle
+::: beignet.rotation_matrix_to_quaternion
+::: beignet.rotation_matrix_to_rotation_vector
+::: beignet.rotation_vector_identity
+::: beignet.rotation_vector_magnitude
+::: beignet.rotation_vector_mean
+::: beignet.rotation_vector_to_euler_angle
+::: beignet.rotation_vector_to_quaternion
+::: beignet.rotation_vector_to_rotation_matrix
+::: beignet.translation_identity

docs/javascripts/mathjax.js

@@ -0,0 +1,19 @@
+window.MathJax = {
+  tex: {
+    inlineMath: [["\\(", "\\)"]],
+    displayMath: [["\\[", "\\]"]],
+    processEscapes: true,
+    processEnvironments: true
+  },
+  options: {
+    ignoreHtmlClass: ".*|",
+    processHtmlClass: "arithmatex"
+  }
+};
+
+document$.subscribe(() => {
+  MathJax.startup.output.clearCache()
+  MathJax.typesetClear()
+  MathJax.texReset()
+  MathJax.typesetPromise()
+})

mkdocs.yml

@@ -1,3 +1,20 @@
+extra_javascript:
+  - "javascripts/mathjax.js"
+  - "https://polyfill.io/v3/polyfill.min.js?features=es6"
+  - "https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js"
+markdown_extensions:
+  - pymdownx.arithmatex:
+      generic: true
+plugins:
+  - mkdocstrings:
+      default_handler: "python"
+      handlers:
+        python:
+          options:
+            docstring_style: "numpy"
+            separate_signature: true
+            show_root_heading: true
+            show_source: true
 site_name: "Beignet"
 theme:
   name: "material"