wntrmute/wrmath
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update sphinx docs; use exhale and breathe.

Browse Source
This commit is contained in:
Kyle Isom
2019-08-07 01:57:26 +00:00
parent 48729670c1
commit 7a932f422a
10 changed files with 209 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/sphinx/index.rst
View File

@@ -3,14 +3,23 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to wrmath's documentation!
==================================
libwrmath: WNTRMUTE ROBOTICS' maths library
===========================================
.. toctree::
:maxdepth: 2
:maxdepth: 3
:caption: Contents:
api
vector
quaternion
resources
api/wrmath
``wrmath`` is a maths library aimed at robotics and navigation
applications. It provides classes for certain mathematics
structures (e.g. :ref:`Vectors <vector-docs>`).
Indices and tables