Add missing definitions.py instead of acronyms.py

sfstoolbox · Dec 19, 2017 · 1bada2b · 1bada2b
1 parent 59b244e
commit 1bada2b
Showing 1 changed file with 23 additions and 3 deletions.
diff --git a/acronyms.py → definitions.py b/acronyms.py → definitions.py
@@ -1,7 +1,7 @@
-# This file defines all acronyms used in the documentation, see
-# http://twoears.aipa.tu-berlin.de/doc/dev/writing-documentation.html#using-acronyms
-rst_epilog = """
+# Definitions of all acronyms used in the document
+acronyms = """
 .. |BRIR|            replace:: :abbr:`BRIR (Binaural Room Impulse Response)`
+.. |DOI|             replace:: :abbr:`DOI (Digital Object Identifier)`
 .. |FFT|             replace:: :abbr:`FFT (Fast Fourier Transform)`
 .. |HOA|             replace:: :abbr:`HOA (Higher Order Ambisonics)`
 .. |HRIR|            replace:: :abbr:`HRIR (Head-Related Impulse Response)`
@@ -14,4 +14,24 @@
 .. |SSR|             replace:: :abbr:`SSR (SoundScape Renderer)`
 .. |WFS|             replace:: :abbr:`WFS (Wave Field Synthesis)`
 """
+
+# Definitions of LaTeX macros used in the document
+latex_macros = r"""
+    \def \i                {\mathrm{i}}
+    \def \e              #1{\mathrm{e}^{#1}}
+    \def \w                {\omega}
+    \def \wc               {\frac{\w}{c}}
+    \def \vec            #1{\mathbf{#1}}
+    \def \x                {\vec{x}}
+    \def \xs               {\x_\text{s}}
+    \def \xref             {\x_\text{ref}}
+    \def \k                {\vec{k}}
+    \def \n                {\vec{n}}
+    \def \d                {\operatorname{d}\!}
+    \def \dirac          #1{\operatorname{\delta}\left(#1\right)}
+    \def \scalarprod   #1#2{\left\langle#1,#2\right\rangle}
+    \def \Hankel     #1#2#3{\mathop{{}H_{#2}^{(#1)}}\!\left(#3\right)}
+    \def \hankel     #1#2#3{\mathop{{}h_{#2}^{(#1)}}\!\left(#3\right)}
+"""
+
 # vim: textwidth=300: