feat(docs): adds starter structure for our docs

wpumacay · Apr 20, 2023 · ddf774c · ddf774c
1 parent 6dcc5de
commit ddf774c
Show file tree

Hide file tree

Showing 10 changed files with 64 additions and 24 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,28 +1,17 @@
-.. TinyMath documentation master file, created by
-   sphinx-quickstart on Mon Jan  6 23:00:07 2020.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
 
-Welcome to Math3d's documentation!
-====================================
+####################
+Math3d Documentation
+####################
 
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-=====================
-C++ API Documentation
-=====================
-
-.. doxygenclass:: math::Vector4
-    :members:
+Math3d is a simple library for manipulation of vectors and matrices, mainly in
+2, 3, and 4 dimensions. It's a core library I use in various projects to avoid
+using other options like **Eigen** or **glm**. It's intended use is for computer
+graphics and physics simulation.
 
-.. doxygenclass:: math::Matrix4
-    :members:
-
-Indices and tables
-==================
+.. toctree::
+   :caption: Contents
+   :maxdepth: 1
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   Getting started <intro/index>
+   User Guide <user/index>
+   API reference <reference/index>
diff --git a/docs/intro/index.rst b/docs/intro/index.rst
@@ -0,0 +1,10 @@
+######################
+Math3d Getting Started
+######################
+
+.. toctree::
+   :caption: Getting Started
+   :maxdepth: 1
+
+   installation
+   overview
diff --git a/docs/intro/installation.rst b/docs/intro/installation.rst
@@ -0,0 +1,3 @@
+############
+Installation
+############
diff --git a/docs/intro/overview.rst b/docs/intro/overview.rst
@@ -0,0 +1,3 @@
+########
+Overview
+########
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -0,0 +1,10 @@
+####################
+Math3d API Reference
+####################
+
+.. toctree::
+   :caption: API Reference
+   :maxdepth: 1
+
+   reference_cpp
+   reference_python
diff --git a/docs/reference/reference_cpp.rst b/docs/reference/reference_cpp.rst
@@ -0,0 +1,6 @@
+#############
+C++ Reference
+#############
+
+.. doxygenclass:: math::Vector4
+   :members:
diff --git a/docs/reference/reference_python.rst b/docs/reference/reference_python.rst
@@ -0,0 +1,3 @@
+################
+Python Reference
+################
diff --git a/docs/user/index.rst b/docs/user/index.rst
@@ -0,0 +1,10 @@
+#################
+Math3d User Guide
+#################
+
+.. toctree::
+   :caption: User Guide
+   :maxdepth: 1
+
+   vectors
+   matrices
diff --git a/docs/user/matrices.rst b/docs/user/matrices.rst
@@ -0,0 +1,3 @@
+########
+Matrices
+########
diff --git a/docs/user/vectors.rst b/docs/user/vectors.rst
@@ -0,0 +1,3 @@
+#######
+Vectors
+#######