From b9d4a571de6fb10a6e37659edd0c742fba6a4db2 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maximilian=20Ke=C3=9Fler?= <git@maximilian-kessler.de>
Date: Sun, 30 Jan 2022 18:40:44 +0100
Subject: [PATCH] document mathfig package

---
 doc/math/mathfig/.latexmkrc  |  4 +++
 doc/math/mathfig/Makefile    |  8 +++++
 doc/math/mathfig/mathfig.tex | 70 ++++++++++++++++++++++++++++++++++++
 3 files changed, 82 insertions(+)
 create mode 100644 doc/math/mathfig/.latexmkrc
 create mode 100644 doc/math/mathfig/Makefile
 create mode 100644 doc/math/mathfig/mathfig.tex

diff --git a/doc/math/mathfig/.latexmkrc b/doc/math/mathfig/.latexmkrc
new file mode 100644
index 0000000..4c81cd6
--- /dev/null
+++ b/doc/math/mathfig/.latexmkrc
@@ -0,0 +1,4 @@
+$makeindex = "makeindex -s gind.ist %O -o %D %S";
+$clean_ext .= ' glo';
+$clean_ext .= ' hd';
+$clean_ext .= ' ins';
diff --git a/doc/math/mathfig/Makefile b/doc/math/mathfig/Makefile
new file mode 100644
index 0000000..e174370
--- /dev/null
+++ b/doc/math/mathfig/Makefile
@@ -0,0 +1,8 @@
+doc:
+	latexmk
+
+full:
+	latexmk -gg
+
+clean:
+	latexmk -C
diff --git a/doc/math/mathfig/mathfig.tex b/doc/math/mathfig/mathfig.tex
new file mode 100644
index 0000000..9fb214d
--- /dev/null
+++ b/doc/math/mathfig/mathfig.tex
@@ -0,0 +1,70 @@
+\documentclass[full]{l3doc}
+
+\title{The \pkg{mkessler-mathfig} package}
+\author{Maximilian Ke\ss ler}
+
+\usepackage{mkessler-mathfig}
+
+
+\begin{document}
+
+\maketitle
+
+\begin{abstract}
+  This is just some small wrapper package for drawing mathematical figures.
+\end{abstract}
+
+\begin{documentation}
+
+\section{Loaded packages}
+We load \pkg{pgfplots}, \pkg{tikz}, \pkg{tikz-cd} and \pkg{xy}.
+
+\section{Additional macros}
+
+\begin{function}{\pushoutsymbol}
+  Denotes a pushoutsymbol used in category theory diagrams.
+\end{function}
+
+\begin{function}{\pullbacksymbol}
+  Denotes a pullbacksymbol used in category theory diagrams.
+\end{function}
+
+\begin{function}{\pushout}
+  \begin{syntax}
+    \cs{pushout}\oarg{path to bottom right corner}
+  \end{syntax}
+  Invoked inside a \env{tikzcd} environment.
+  This assumes being called in the top left corner of some
+  commutative square  and marks this square as a pushout.
+ 
+  The \meta{path} consists of symbols \texttt{d}, \texttt{u}, \texttt{r}
+  and \texttt{l}, as in \pkg{tikz-cd}.
+  By default, it is \texttt{dr}, being usable for default squares.
+
+  A phantom arrow is drawn in the given direction that
+  gets a \cs{pushoutsymbol}.
+\end{function}
+
+\begin{function}{\pullback}
+  \begin{syntax}
+    \cs{pullback}\oarg{path to bottom right corner}
+  \end{syntax}
+  Invoked inside a \env{tikzcd} environment.
+  This assumes being called in the top left corner of some
+  commutative square  and marks this square as a pullback.
+ 
+  The \meta{path} consists of symbols \texttt{d}, \texttt{u}, \texttt{r}
+  and \texttt{l}, as in \pkg{tikz-cd}.
+  By default, it is \texttt{dr}, being usable for default squares.
+
+  A phantom arrow is drawn in the given direction that
+  gets a \cs{pullbacksymbol}.
+\end{function}
+
+  
+\end{documentation}
+
+
+\PrintIndex
+  
+\end{document}