Skip to content

Commit

Permalink
xo-ratio: docs: + .rst files ratio-reference/functions/class
Browse files Browse the repository at this point in the history
  • Loading branch information
Rconybea committed Apr 19, 2024
1 parent 15b9162 commit 6a8bfc3
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Why ``ratio``?
:caption: xo-ratio contents:

install
ratio-reference

Indices and Tables
------------------
Expand Down
47 changes: 47 additions & 0 deletions docs/ratio-class.rst
Original file line number Diff line number Diff line change
@@ -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
17 changes: 17 additions & 0 deletions docs/ratio-functions.rst
Original file line number Diff line number Diff line change
@@ -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
11 changes: 11 additions & 0 deletions docs/ratio-reference.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _ratio-reference:

Ratio Reference
===============

.. toctree::
:maxdepth: 2
:caption: Ratio Reference

ratio-class
ratio-functions

0 comments on commit 6a8bfc3

Please sign in to comment.