aboutsummaryrefslogtreecommitdiff
path: root/docs/api/angles.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api/angles.rst')
-rw-r--r--docs/api/angles.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/api/angles.rst b/docs/api/angles.rst
new file mode 100644
index 0000000..609bb33
--- /dev/null
+++ b/docs/api/angles.rst
@@ -0,0 +1,24 @@
+Angles
+======
+
+.. py:module:: thcolor.angles
+
+Some color representations use angles as some of their properties. The base
+class for angles is the following:
+
+.. autoclass:: Angle
+ :members: asdegrees, asgradians, asradians, asturns
+
+Subclasses are the following:
+
+.. autoclass:: DegreesAngle
+ :members: degrees
+
+.. autoclass:: GradiansAngle
+ :members: gradians
+
+.. autoclass:: RadiansAngle
+ :members: radians
+
+.. autoclass:: TurnsAngle
+ :members: turns