xo-ratio: docs: + .rst files ratio-reference/functions/class

docs/index.rst

@@ -26,6 +26,7 @@ Why ``ratio``?
    :caption: xo-ratio contents:
 
    install
+   ratio-reference
 
 Indices and Tables
 ------------------

docs/ratio-class.rst

@@ -0,0 +1,47 @@
+.. _ratio-class:
+
+Ratio
+=====
+
+.. code-block:: cpp
+
+    #include <xo/ratio/ratio.hpp>
+
+A ``ratio`` represents an exact fraction of two integers.
+
+.. doxygenclass:: xo::ratio::ratio
+
+Instance Variables
+------------------
+
+.. doxygengroup:: ratio-instance-variables
+
+Types
+-----
+
+.. doxygengroup:: ratio-types
+
+Constructors
+------------
+
+.. doxygengroup:: ratio-ctor
+
+Static Methods
+--------------
+
+.. doxygengroup:: ratio-static-methods
+
+Access Methods
+--------------
+
+.. doxygengroup:: ratio-access
+
+General Methods
+---------------
+
+.. doxygengroup:: ratio-methods
+
+Conversion
+----------
+
+.. doxygengroup:: ratio-conversion

docs/ratio-functions.rst

@@ -0,0 +1,17 @@
+.. _ratio_functions:
+
+.. toctree::
+   :maxdepth: 2
+
+Ratio Functions
+===============
+
+.. code-block:: cpp
+
+    #include <xo/ratio/ratio.hpp>
+
+.. doxygenfunction:: xo::ratio::make_ratio
+
+.. doxygengroup:: ratio-arithmetic
+
+.. doxygengroup:: ratio-3way-compare

docs/ratio-reference.rst

@@ -0,0 +1,11 @@
+.. _ratio-reference:
+
+Ratio Reference
+===============
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Ratio Reference
+
+   ratio-class
+   ratio-functions