From 44e61cc4d960c1a3c9bf26637fb5e3d9c80870e3 Mon Sep 17 00:00:00 2001 From: BalzaniEdoardo Date: Wed, 4 Dec 2024 14:28:11 -0500 Subject: [PATCH] fixing links --- docs/background/basis/README.md | 32 +++++++++---------- .../basis/plot_01_1D_basis_function.md | 2 +- docs/conf.py | 6 +++- docs/scripts/basis_table_figs.py | 2 +- 4 files changed, 23 insertions(+), 19 deletions(-) diff --git a/docs/background/basis/README.md b/docs/background/basis/README.md index 60516ad4..60789b5c 100644 --- a/docs/background/basis/README.md +++ b/docs/background/basis/README.md @@ -19,44 +19,44 @@ * - **B-Spline** - .. plot:: scripts/basis_table_figs.py plot_bspline :show-source-link: False - - `Grid cells `_ - - `EvalBSpline `_ :raw-html:`
` - `BSplineConv `_ + - :ref:`Grid cells ` + - :class:`~nemos.basis.BSplineEval` :raw-html:`
` + :class:`~nemos.basis.BSplineConv` - 🟢 Eval * - **Cyclic B-Spline** - .. plot:: scripts/basis_table_figs.py plot_cyclic_bspline :show-source-link: False - - `Place cells `_ - - `EvalCyclicBSpline `_ :raw-html:`
` - `ConvCyclicBSpline `_ + - :ref:`Place cells ` + - :class:`~nemos.basis.CyclicBSplineEval` :raw-html:`
` + :class:`~nemos.basis.CyclicBSplineConv` - 🟢 Eval * - **M-Spline** - .. plot:: scripts/basis_table_figs.py plot_mspline :show-source-link: False - - `Place cells `_ - - `EvalMSpline `_ :raw-html:`
` - `ConvMSpline `_ + - :ref:`Place cells ` + - :class:`~nemos.basis.MSplineEval` :raw-html:`
` + :class:`~nemos.basis.MSplineConv` - 🟢 Eval * - **Linearly Spaced Raised Cosine** - .. plot:: scripts/basis_table_figs.py plot_raised_cosine_linear :show-source-link: False - - - `EvalRaisedCosineLinear `_ :raw-html:`
` - `ConvRaisedCosineLinear `_ + - :class:`~nemos.basis.RaisedCosineLinearEval` :raw-html:`
` + :class:`~nemos.basis.RaisedCosineLinearConv` - 🟢 Eval * - **Log Spaced Raised Cosine** - .. plot:: scripts/basis_table_figs.py plot_raised_cosine_log :show-source-link: False - - `Head Direction `_ - - `EvalRaisedCosineLog `_ :raw-html:`
` - `ConvRaisedCosineLog `_ + - :ref:`Head Direction ` + - :class:`~nemos.basis.RaisedCosineLogEval` :raw-html:`
` + :class:`nemos.basis.RaisedCosineLogConv` - 🔵 Conv * - **Orthogonalized Exponential Decays** - .. plot:: scripts/basis_table_figs.py plot_orth_exp_basis :show-source-link: False - - - `EvalOrthExponential `_ :raw-html:`
` - `ConvOrthExponential `_ + - :class:`~nemos.basis.OrthExponentialEval` :raw-html:`
` + :class:`~nemos.basis.OrthExponentialConv` - 🟢 Eval ``` diff --git a/docs/background/basis/plot_01_1D_basis_function.md b/docs/background/basis/plot_01_1D_basis_function.md index 29f32993..36ab66d6 100644 --- a/docs/background/basis/plot_01_1D_basis_function.md +++ b/docs/background/basis/plot_01_1D_basis_function.md @@ -156,7 +156,7 @@ Convolution is performed in "valid" mode, and then NaN-padded. The default behav is padding left, which makes the output feature causal. This is why the first half of the `conv_feature` is full of NaNs and appears as white. If you want to learn more about convolutions, as well as how and when to change defaults -check out the tutorial on [1D convolutions](plot_03_1D_convolution). +check out the tutorial on [1D convolutions](convolution_background). ::: diff --git a/docs/conf.py b/docs/conf.py index f4d73d48..2e752238 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -123,7 +123,11 @@ "logo": { "image_light": "_static/NeMoS_Logo_CMYK_Full.svg", "image_dark": "_static/NeMoS_Logo_CMYK_White.svg", - } + }, + "secondary_sidebar_items": { + "**": ["page-toc", "sourcelink"], + "background/basis/README": [], + }, } html_sidebars = { diff --git a/docs/scripts/basis_table_figs.py b/docs/scripts/basis_table_figs.py index 721f6635..3a442c6e 100644 --- a/docs/scripts/basis_table_figs.py +++ b/docs/scripts/basis_table_figs.py @@ -24,7 +24,7 @@ def plot_basis(cls): cls_params = cls._get_param_names() new_kwargs = trim_kwargs(cls, KWARGS.copy(), {cls.__name__: cls_params}) bas = cls(**new_kwargs) - fig, ax = plt.subplots(1, 1, figsize=(5, 2.5)) + fig, ax = plt.subplots(1, 1, figsize=(5/4, 2.5/4)) ax.plot(*bas.evaluate_on_grid(300), lw=4) for side in ["left", "right", "top", "bottom"]: ax.spines[side].set_visible(False)