📝 Write the documentation

.envrc

@@ -0,0 +1 @@
+use flake

.gitignore

@@ -17,4 +17,11 @@ temp.errors
 .d/
 
 # Template Zips
-*.zip
+*.zip
+
+# Flake stuff
+.direnv
+
+# Built docs
+docs/_build
+docs/xml

.readthedocs.yml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt

Makefile

@@ -24,7 +24,7 @@ USE_PACKAGE:=1
 EXCLUDE_COLD_LIBRARIES:= 
 
 # Set this to 1 to add additional rules to compile your project as a PROS library template
-IS_LIBRARY:=1
+IS_LIBRARY:=0
 # TODO: CHANGE THIS! 
 # Be sure that your header files are in the include directory inside of a folder with the
 # same name as what you set LIBNAME to below.

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api.md

@@ -0,0 +1,61 @@
+# API Reference
+
+## Abstract Quantities
+
+```{doxygenclass} Quantity
+:members:
+```
+
+## Generic Operations
+
+```{doxygengroup} operations
+:members:
+:inner:
+```
+
+
+## Quantities
+
+### Number
+
+```{doxygengroup} Number
+:content-only:
+:members:
+```
+
+### Mass
+
+```{doxygengroup} Mass
+:content-only:
+:members:
+```
+
+<!--### Time-->
+<!--### Length-->
+<!--### Area-->
+<!--### Linear Velocity-->
+<!--### Linear Acceleration-->
+<!--### Linear Jerk-->
+<!--### Curvature-->
+<!--### Inertia-->
+<!--### Force-->
+<!--### Torque-->
+<!--### Power-->
+<!--### Current-->
+<!--### Charge-->
+<!--### Voltage-->
+<!--### Resistance-->
+<!--### Conductance-->
+<!--### Luminosity-->
+<!--### Moles-->
+<!--### Angle-->
+<!--### Pose-->
+<!--### Temperature-->
+<!--### Vector 2D-->
+<!--### Vector 3D-->
+
+## units.hpp
+
+```{doxygenfile} units.hpp
+
+```

docs/conf.py

@@ -0,0 +1,73 @@
+project = "Units"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "breathe",
+    "myst_parser",
+    "sphinx_copybutton",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.todo",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+
+html_theme_options = {
+    "source_repository": "https://github.com/lemlib/lemlib/",
+    "source_branch": "master",
+    "source_directory": "docs/",
+    "light_css_variables": {
+        "color-brand-primary": "#00C852",
+        "color-brand-content": "#00C852",
+    },
+    "dark_css_variables": {
+        "color-brand-primary": "#00C852",
+        "color-brand-content": "#00C852",
+    },
+}
+
+html_static_path = ["_static"]
+
+
+breathe_projects = {"Units": "xml/"}
+
+breathe_projects_source = {
+    "Units": ("../", ["include/units"])
+}
+
+breathe_default_project = "Units"
+
+myst_enable_extensions = [
+    "amsmath",
+    "attrs_inline",
+    "colon_fence",
+    "deflist",
+    "dollarmath",
+    "fieldlist",
+    "html_admonition",
+    "html_image",
+    "linkify",
+    "replacements",
+    "smartquotes",
+    "strikethrough",
+    "substitution",
+    "tasklist",
+]
+
+
+# Run doxygen for the readthedocs build
+
+import subprocess, os
+
+read_the_docs_build = os.environ.get("READTHEDOCS", None) == "True"
+
+if read_the_docs_build:
+    subprocess.call("cd ../doxygen; doxygen", shell=True)

docs/index.md

@@ -0,0 +1,15 @@
+# Home
+
+We love documentation.
+
+bob
+
+```{toctree}
+:hidden:
+:maxdepth: 2
+:caption: Index
+
+self
+<!--./tutorials/index-->
+./api.md
+```

docs/requirements.txt

@@ -0,0 +1,5 @@
+breathe
+myst-parser
+furo
+sphinx-copybutton
+linkify-it-py

flake.nix

@@ -0,0 +1,41 @@
+{
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+    utils.url = "github:numtide/flake-utils";
+    #pros-cli-nix.url = "/home/battlechicken/Projects/pros-cli-nix";
+    pros-cli-nix.url = "github:BattleCh1cken/pros-cli-nix";
+  };
+
+  outputs =
+    { self
+    , nixpkgs
+    , utils
+    , pros-cli-nix
+    }:
+    utils.lib.eachDefaultSystem (system:
+    let
+      pkgs = import nixpkgs { inherit system; };
+    in
+    {
+      devShell = pkgs.mkShell {
+        packages = with pkgs; [
+          pros-cli-nix.packages.${system}.default
+          clang-tools
+          gcc-arm-embedded-10
+
+          doxygen
+
+          python312
+          python312Packages.pip
+          python312Packages.breathe
+          python312Packages.furo
+          python312Packages.myst-parser
+          python312Packages.sphinx-copybutton
+          python312Packages.linkify-it-py
+
+          sphinx-autobuild
+          sphinx
+        ];
+      };
+    });
+}