Files
cglm/docs/source/index.rst
Christopher Lang 52debe6a04 improve docs index
2022-05-08 21:49:30 +01:00

56 lines
1.0 KiB
ReStructuredText

.. cglm documentation master file, created by
sphinx-quickstart on Tue Jun 6 20:31:05 2017.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
cglm Documentation
================================
**cglm** is an optimized 3D math library written in C99 (compatible with C89).
It is similar to the original **glm** library, except **cglm** is mainly for
**C**.
**cglm** stores matrices as column-major order but in the future row-major is
considered to be supported as optional.
Currently only **float** type is supported for most operations.
.. toctree::
:maxdepth: 2
:caption: Getting Started:
features
build
getting_started
.. toctree::
:maxdepth: 2
:caption: How To:
opengl
.. toctree::
:maxdepth: 2
:caption: API:
api
.. toctree::
:maxdepth: 2
:caption: Options:
opt
.. toctree::
:maxdepth: 2
:caption: Troubleshooting:
troubleshooting
Indices and Tables:
===================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`