From 7c45e4c3a1c395bcc404e736cecb57d1597c93c8 Mon Sep 17 00:00:00 2001
From: Oscar Gustafsson <oscar.gustafsson@gmail.com>
Date: Mon, 13 Feb 2023 12:12:53 +0100
Subject: [PATCH] Fix NumPy crosslinks
---
b_asic/signal_generator.py | 14 +++++++-------
docs_sphinx/conf.py | 3 ++-
2 files changed, 9 insertions(+), 8 deletions(-)
diff --git a/b_asic/signal_generator.py b/b_asic/signal_generator.py
index fce18c42..17abe39f 100644
--- a/b_asic/signal_generator.py
+++ b/b_asic/signal_generator.py
@@ -170,7 +170,7 @@ class Sinusoid(SignalGenerator):
frequency : float
The normalized frequency of the sinusoid. Should normally be in the
interval [0, 1], where 1 corresponds to half the sample rate.
- phase : float, default: 0
+ phase : float, default: 0.0
The normalized phase offset.
"""
@@ -193,15 +193,15 @@ class Gaussian(SignalGenerator):
"""
Signal generator with Gaussian noise.
- See :class:`numpy.random.Generator.normal` for further details.
+ See :py:meth:`numpy.random.Generator.normal` for further details.
Parameters
----------
seed : int, optional
The seed of the random number generator.
- scale : float, default: 1
+ scale : float, default: 1.0
The standard deviation of the noise.
- loc : float, default: 0
+ loc : float, default: 0.0
The average value of the noise.
"""
@@ -232,16 +232,16 @@ class Uniform(SignalGenerator):
"""
Signal generator with uniform noise.
- See :class:`numpy.random.Generator.normal` for further details.
+ See :py:meth:`numpy.random.Generator.normal` for further details.
Parameters
----------
seed : int, optional
The seed of the random number generator.
- low : float, default: -1
+ low : float, default: -1.0
The lower value of the uniform range.
- high : float, default: 1
+ high : float, default: 1.0
The upper value of the uniform range.
"""
diff --git a/docs_sphinx/conf.py b/docs_sphinx/conf.py
index f49a852c..c0ac067d 100644
--- a/docs_sphinx/conf.py
+++ b/docs_sphinx/conf.py
@@ -8,7 +8,7 @@
import shutil
project = 'B-ASIC'
-copyright = '2020-2022, Oscar Gustafsson et al'
+copyright = '2020-2023, Oscar Gustafsson et al'
author = 'Oscar Gustafsson et al'
html_logo = "../logo_tiny.png"
@@ -37,6 +37,7 @@ intersphinx_mapping = {
'python': ('https://docs.python.org/3/', None),
'graphviz': ('https://graphviz.readthedocs.io/en/stable/', None),
'matplotlib': ('https://matplotlib.org/stable/', None),
+ 'numpy': ('https://numpy.org/doc/stable/', None),
'PyQt5': ("https://www.riverbankcomputing.com/static/Docs/PyQt5", None),
}
--
GitLab