Skip to content
Draft
2 changes: 1 addition & 1 deletion .readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,5 @@ python:
path: .
extra_requirements:
- mkdocs
- mktheapidocs
- mkapi
- pymdown-extensions
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ from other representations of rotations, including

* `to_rotation_matrix`, `from_rotation_matrix`
* `to_transformation_matrix` (for non-unit quaternions)
* `to_axis_angle`, `from_axis_angle` representation
* `to_axis_angle`, `from_axis_angle`
* `to_euler_angles`, `from_euler_angles` (though using Euler angles is almost always a bad idea)
* `to_spherical_coordinates`, `from_spherical_coordinates`
* `to_angular_velocity`, `from_angular_velocity`
Expand Down Expand Up @@ -200,7 +200,7 @@ np.max(quaternionic.distance.rotation.intrinsic(q1, q2)) # Typically around 1e-

## Distance functions

The `quaternionic.distance` contains four distance functions:
The `quaternionic.distance` module contains four distance functions:

* `rotor.intrinsic`
* `rotor.chordal`
Expand Down
13 changes: 8 additions & 5 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,12 @@ site_name: quaternionic
repo_url: https://github.com/moble/quaternionic

plugins:
- mktheapidocs:
modules:
quaternionic:
section: api
source_repo: "https://github.com/moble/quaternionic/blob/master"
- search
- mkapi

nav:
- index.md
- API: mkapi/api/quaternionic

theme:
name: 'readthedocs'
Expand All @@ -16,5 +17,7 @@ extra_javascript:
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-svg.js

markdown_extensions:
- toc:
permalink: "#"
- pymdownx.arithmatex:
generic: true
Loading