From b8289c72fa42038e2094ad18b6aa53f7ccb9aea6 Mon Sep 17 00:00:00 2001
From: Montgomery Alban <mtuck2005@yahoo.ca>
Date: Fri, 19 May 2023 20:34:04 +0000
Subject: [PATCH] Add sphinx spelling check.

---
 docs/conf.py               |  7 ++++
 docs/spelling_wordlist.txt | 77 ++++++++++++++++++++++++++++++++++++++
 setup.cfg                  |  1 +
 3 files changed, 85 insertions(+)
 create mode 100644 docs/spelling_wordlist.txt

diff --git a/docs/conf.py b/docs/conf.py
index 9aa26cc457..6a229ecc59 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -43,6 +43,7 @@
     "sphinx_rtd_theme",  # Read The Docs theme
     "sphinx_click",  # extract documentation from a `click` application
     "sphinxcontrib.apidoc",
+    "sphinxcontrib.spelling",
 ]
 
 extlinks = {
@@ -106,6 +107,12 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
+# -- Options for spelling ----------------------------------------------------
+spelling_exclude_patterns = ["ignored_*", "**/*_pb2*"]
+spelling_ignore_pypi_package_names = True
+spelling_show_suggestions = True
+spelling_suggestion_limit = 2
+spelling_word_list_filename = ["spelling_wordlist.txt"]
 
 # -- Options for HTML output -------------------------------------------------
 
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
new file mode 100644
index 0000000000..8bca9c9799
--- /dev/null
+++ b/docs/spelling_wordlist.txt
@@ -0,0 +1,77 @@
+π
+Δx
+Δy
+Δheading
+ΔTime
+accelerometer
+Ackermann
+acyclic
+acyclical
+Argoverse
+args
+bezier
+boid
+boids
+centric
+coord
+coords
+dataset
+datasets
+deserialize
+deserializes
+deserialized
+deserializable
+deterministically
+dir
+disjunction
+drivable
+dt
+dtype
+egoless
+Env
+fallbacks
+frenet
+indexable
+infos
+instantiating
+instantiation
+instantiations
+iterable
+lanepoint
+laner
+lidar
+lookahead
+natively
+np
+numpy
+ndarray
+param
+pre
+quaternion
+quaternions
+quickstart
+rebase
+renderer
+renderers
+repurposes
+rtype
+scalable
+scalability
+serialize
+serializes
+serialized
+serializable
+str
+timestep
+Todo
+travelled
+unassociated
+unformatted
+unmanaged
+untriggered
+Vandenberghe
+vectorized
+waypoint
+waypoints
+Waymo
+Welford
\ No newline at end of file
diff --git a/setup.cfg b/setup.cfg
index dd319fc498..e013c79fc7 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -77,6 +77,7 @@ doc =
     myst-parser>=0.18.1
     sphinx>=5.3.0
     sphinxcontrib-apidoc>=0.3.0
+    sphinxcontrib-spelling>=8.0.0
     sphinx-click>=4.4.0
     sphinx-rtd-theme>=1.1.1
 envision =