diff --git a/.gitignore b/.gitignore
index fc8ef955b..9ee0b2652 100644
--- a/.gitignore
+++ b/.gitignore
@@ -6,4 +6,7 @@
build/
*.swp
doxygen-docs/
+docs/_build/
+docs/api/reference/
+docs/xml/
__pycache__
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
new file mode 100644
index 000000000..4ddc09f6b
--- /dev/null
+++ b/.readthedocs.yaml
@@ -0,0 +1,18 @@
+version: 2
+
+build:
+ os: ubuntu-24.04
+ tools:
+ python: "3.12"
+ apt_packages:
+ - doxygen
+ jobs:
+ pre_build:
+ - rm -rf docs/xml && cd docs && doxygen Doxyfile
+
+sphinx:
+ configuration: docs/conf.py
+
+python:
+ install:
+ - requirements: docs/requirements.txt
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 066786e09..612211975 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -4,6 +4,7 @@
- Added 3, 10, 37, and 39 bus test cases.
- Updated documentation.
+- Added support for Read the Docs
- Added JSON parsing.
- Automatic differentiation with enzyme (w.r.t. internal and external variables).
- Added PR and issue templates.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 4985b656a..1a446018e 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -107,11 +107,11 @@ required.
Doxygen supports Markdown markup and it should be used to make documentation
more clear. For example,
-```c++
+```text
* @return The size of `a`
```
is clearer than
-```c++
+```text
* @return The size of a
```
when read in plain text and in formatted documentation.
diff --git a/GridKit/CommonMath.md b/GridKit/CommonMath.md
index 9f9f9bdcc..9c1995e51 100644
--- a/GridKit/CommonMath.md
+++ b/GridKit/CommonMath.md
@@ -1,6 +1,6 @@
# CommonMath
-Smooth, autodiff-friendly replacements for piecewise functions used across GridKit component models. See [CommonMath.hpp](CommonMath.hpp) for implementation details.
+Smooth, autodiff-friendly replacements for piecewise functions used across GridKit component models. See `CommonMath.hpp` for implementation details.
## Primitives
@@ -28,7 +28,7 @@ The sigmoid is also known as the logistic function. The equivalent `tanh` form i
\end{aligned}
```
-
+
### $\rho$ - `ramp`
@@ -42,7 +42,7 @@ The sigmoid is also known as the logistic function. The equivalent `tanh` form i
\end{aligned}
```
-
+
### $q$ - `qramp`
@@ -52,7 +52,7 @@ The sigmoid is also known as the logistic function. The equivalent `tanh` form i
q(x)=x^2\,\sigma(x)
```
-
+
## Derived Functions
@@ -85,7 +85,7 @@ q(x)=x^2\,\sigma(x)
\end{aligned}
```
-
+
### `min`
@@ -101,7 +101,7 @@ q(x)=x^2\,\sigma(x)
\end{aligned}
```
-
+
### `clamp`
@@ -118,7 +118,7 @@ q(x)=x^2\,\sigma(x)
\end{aligned}
```
-
+
### `deadband1`
@@ -135,7 +135,7 @@ q(x)=x^2\,\sigma(x)
\end{aligned}
```
-
+
### `deadband2`
@@ -152,7 +152,7 @@ q(x)=x^2\,\sigma(x)
\end{aligned}
```
-
+
### `slew`
@@ -169,7 +169,7 @@ q(x)=x^2\,\sigma(x)
\end{aligned}
```
-
+
### `linseg`
@@ -186,7 +186,7 @@ q(x)=x^2\,\sigma(x)
\end{aligned}
```
-
+
### `above`
@@ -202,7 +202,7 @@ q(x)=x^2\,\sigma(x)
\end{aligned}
```
-
+
### `below`
@@ -218,7 +218,7 @@ q(x)=x^2\,\sigma(x)
\end{aligned}
```
-
+
### `inside`
@@ -234,7 +234,7 @@ q(x)=x^2\,\sigma(x)
\end{aligned}
```
-
+
### `outside`
@@ -250,7 +250,7 @@ q(x)=x^2\,\sigma(x)
\end{aligned}
```
-
+
### `antiwindup`
diff --git a/GridKit/Model/EMT/Component/Branch/BranchLumpedConstant/README.md b/GridKit/Model/EMT/Component/Branch/BranchLumpedConstant/README.md
index 17a7374ea..0ec665ed2 100644
--- a/GridKit/Model/EMT/Component/Branch/BranchLumpedConstant/README.md
+++ b/GridKit/Model/EMT/Component/Branch/BranchLumpedConstant/README.md
@@ -7,11 +7,9 @@ Series current $\mathbf{i}$ is directed from bus 1 to bus 2. Bus residual
current injections are positive into buses. All electrical parameter matrices
are $3 \times 3$ and capture self and mutual coupling between phases.
-
-
+
- Figure 1: Lumped constant EMT branch model
-
-
+
- Figure 1: Branch equivalent circuit
-
-
-
- Figure 1: Needs to be changed to represent current balance instead of power
- balance.
-
-
+
- Figure 1: REECA block diagram. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 1: Generator/Converter REGCA model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 1: Generator/Converter REGCB model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 1: Exciter ESAC6A model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 1: Exciter ESDC2A model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 1: Exciter ESST4B model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 1: Exciter EXAC1 model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 1: Exciter EXAC2 model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
-
- Figure 1: Exciter EXDC1 model. Figure courtesy of [PoweWorld](https://www.powerworld.com/WebHelp/).
-
-
+
- Figure 1: Exciter EXPIC1 model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
-
- Figure 1: Exciter IEEET1 model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 1: Exciter SCRX model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 1: Exciter SEXS-PTI model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 1: Governor GGOV1 model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 1: Governor IEEEG1 model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
-
- Figure 1: Governor TGOV1 model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 1: Stabilizer IEEEST model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
-
-
- Figure 1: Power system stabilizer PSS1A model. Figure courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
-
- Figure 2: GENROU. Figure courtesy of
- [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 2: GENSAL. Figure courtesy of
- [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
+
- Figure 1: Synchronous Machine. Figure courtesy of
- [PowerWorld](https://www.powerworld.com/files/Synchronous-Machines.pdf/)
-
-
-
-
- Figure 1: Transmission line $`\pi`$ equivalent circuit
-
-
-
-
- Figure 2: Branch equivalent circuit
-
-
-
-
- Figure 1: Sign convention for the power flow at the bus $`i`$
-
-
+
- Figure 1: Oneline of the ACTIVSg200 Case, from Texas A&M University [Grid Repository](https://electricgrids.engr.tamu.edu/electric-grid-test-cases/activsg200/) (Updated Oneline WIP)
-
-
+
- Figure 1: Oneline of the WECC case of [National Laboratory of the Rockies](https://www.nlr.gov/grid/test-case-repository)
-
-
+
- Figure 1: Oneline of the synthetic Hawaii case, courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/) (WIP Updated Oneline)
-
-
+
- Figure 1: Oneline of the New England IEEE 39-bus case, courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
-
- Figure 1: Oneline of the two-area Case, courtesy of [PowerWorld](https://www.powerworld.com/WebHelp/)
-
-
-
-
- Figure 1: A simple 3-bus grid example.
-
