CI: fix doc building

.github/workflows/ubuntu-latest.yml

@@ -46,3 +46,10 @@ jobs:
       run: |
         coverage run -m --source=rateslib pytest
         coverage report -m
+    - name: Install Pandoc
+      uses: r-lib/actions/setup-pandoc@v2
+      with:
+        pandoc-version: '3.2' # The pandoc version to download (if necessary) and use.
+    - name: Build Docs
+      run: |
+        cd docs && make html

docs/source/i_api.rst

@@ -160,28 +160,6 @@ Curves
    :no-heading:
    :inherited-members:
    :no-inheritance-diagram:
-   :skip: NoInput
-   :skip: Modifier
-   :skip: set_order_convert
-   :skip: add_tenor
-   :skip: create_calendar
-   :skip: dcf
-   :skip: dual_exp
-   :skip: dual_log
-   :skip: floor
-   :skip: get_calendar
-   :skip: plot
-   :skip: uuid4
-   :skip: Any
-   :skip: Dual
-   :skip: Dual2
-   :skip: PPSplineF64
-   :skip: PPSplineDual
-   :skip: PPSplineDual2
-   :skip: datetime
-   :skip: timedelta
-   :skip: comb
-   :skip: index_left_f64
 
 Class Inheritance Diagram
 --------------------------
@@ -220,6 +198,9 @@ FX Volatility
    :skip: uuid4
    :skip: Union
    :skip: datetime
+   :skip: dt
+   :skip: timedelta
+   :skip: Series
 
 Periods
 ========

pyproject.toml

@@ -37,7 +37,7 @@ classifiers = [
 dev = [
     "pytest>=7.0.1",
     "jupyterlab>=3.3.1",
-    "sphinx>=7.1.0",
+    "sphinx>=7.1.0,<8.0",
     "coverage>=7.1.0",
     "sphinx-automodapi==0.16.0",
     "pydata-sphinx-theme==0.14.3",

python/rateslib/calendars/__init__.py

@@ -513,15 +513,15 @@ def _get_fx_expiry_and_delivery(
 
 
 __all__ = (
-    add_tenor,
-    Cal,
-    CalInput,
-    CalTypes,
-    create_calendar,
-    dcf,
-    Modifier,
-    NamedCal,
-    RollDay,
-    UnionCal,
-    get_calendar,
+    "add_tenor",
+    "Cal",
+    "CalInput",
+    "CalTypes",
+    "create_calendar",
+    "dcf",
+    "Modifier",
+    "NamedCal",
+    "RollDay",
+    "UnionCal",
+    "get_calendar",
 )

python/rateslib/curves/__init__.py

@@ -11,13 +11,13 @@
 )
 
 __all__ = (
-    CompositeCurve,
-    Curve,
-    IndexCurve,
-    LineCurve,
-    MultiCsaCurve,
-    ProxyCurve,
-    average_rate,
-    index_left,
-    interpolate,
+    "CompositeCurve",
+    "Curve",
+    "IndexCurve",
+    "LineCurve",
+    "MultiCsaCurve",
+    "ProxyCurve",
+    "average_rate",
+    "index_left",
+    "interpolate",
 )

python/rateslib/fx/__init__.py

@@ -1,4 +1,4 @@
 from rateslib.fx.fx_forwards import FXForwards, forward_fx
 from rateslib.fx.fx_rates import FXRates
 
-__all__ = (FXForwards, forward_fx, FXRates)
+__all__ = ("FXForwards", "forward_fx", "FXRates")

python/rateslib/instruments.py

@@ -1,4 +1,3 @@
-
 # Sphinx substitutions
 
 import abc

python/rateslib/solver.py

@@ -1502,9 +1502,7 @@ def delta(self, npv, base: str | NoInput = NoInput(0), fx=NoInput(0)):
         sorted_cols = df.columns.sort_values()
         return df.loc[:, sorted_cols].astype("float64")
 
-    def _get_base_and_fx(
-        self, base: str | NoInput, fx: FXForwards | FXRates | float | NoInput
-    ):
+    def _get_base_and_fx(self, base: str | NoInput, fx: FXForwards | FXRates | float | NoInput):
         if base is not NoInput.blank and self.fx is NoInput.blank and fx is NoInput.blank:
             raise ValueError(
                 "`base` is given but `fx` is not and Solver does not "

python/rateslib/splines.py

@@ -47,4 +47,11 @@ def evaluate(
         return spline.ppdnev_single(x, m)
 
 
-__all__ = (PPSplineDual, PPSplineDual2, PPSplineF64, PPSpline, bspldnev_single, bsplev_single)
+__all__ = (
+    "PPSplineDual",
+    "PPSplineDual2",
+    "PPSplineF64",
+    "PPSpline",
+    "bspldnev_single",
+    "bsplev_single",
+)