Skip to content

Commit 0debc3d

Browse files
committed
use ..autofunction over autosummary for exported methods in interfaces namespace
1 parent 416ceb1 commit 0debc3d

File tree

1 file changed

+50
-58
lines changed

1 file changed

+50
-58
lines changed

docs/source/reference/interfaces.rst

Lines changed: 50 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -37,74 +37,66 @@ Functions
3737

3838
**Seeding and state functions:**
3939

40-
.. autosummary::
41-
42-
mkl_random.interfaces.numpy_random.seed
43-
mkl_random.interfaces.numpy_random.get_state
44-
mkl_random.interfaces.numpy_random.set_state
40+
.. autofunction:: mkl_random.interfaces.numpy_random.seed
41+
.. autofunction:: mkl_random.interfaces.numpy_random.get_state
42+
.. autofunction:: mkl_random.interfaces.numpy_random.set_state
4543

4644
**Simple random data:**
4745

4846
Similar to NumPy, the methods of :class:`RandomState` are exported as functions in the module.
4947
Their usage is discouraged, as they are implemented from a global instance of :class:`RandomState`,
5048
which means results may change across calls.
5149

52-
.. autosummary::
53-
54-
mkl_random.interfaces.numpy_random.rand
55-
mkl_random.interfaces.numpy_random.randn
56-
mkl_random.interfaces.numpy_random.randint
57-
mkl_random.interfaces.numpy_random.random_integers
58-
mkl_random.interfaces.numpy_random.random_sample
59-
mkl_random.interfaces.numpy_random.random
60-
mkl_random.interfaces.numpy_random.ranf
61-
mkl_random.interfaces.numpy_random.choice
62-
mkl_random.interfaces.numpy_random.bytes
63-
mkl_random.interfaces.numpy_random.sample
50+
.. autofunction:: mkl_random.interfaces.numpy_random.rand
51+
.. autofunction:: mkl_random.interfaces.numpy_random.randn
52+
.. autofunction:: mkl_random.interfaces.numpy_random.randint
53+
.. autofunction:: mkl_random.interfaces.numpy_random.random_integers
54+
.. autofunction:: mkl_random.interfaces.numpy_random.random_sample
55+
.. autofunction:: mkl_random.interfaces.numpy_random.random
56+
.. autofunction:: mkl_random.interfaces.numpy_random.ranf
57+
.. autofunction:: mkl_random.interfaces.numpy_random.choice
58+
.. autofunction:: mkl_random.interfaces.numpy_random.bytes
59+
.. autofunction:: mkl_random.interfaces.numpy_random.sample
6460

6561
**Permutations:**
6662

67-
.. autosummary::
68-
69-
mkl_random.interfaces.numpy_random.shuffle
70-
mkl_random.interfaces.numpy_random.permutation
63+
.. autofunction:: mkl_random.interfaces.numpy_random.shuffle
64+
.. autofunction:: mkl_random.interfaces.numpy_random.permutation
7165

7266
**Distributions:**
7367

74-
.. autosummary::
75-
76-
mkl_random.interfaces.numpy_random.beta
77-
mkl_random.interfaces.numpy_random.binomial
78-
mkl_random.interfaces.numpy_random.chisquare
79-
mkl_random.interfaces.numpy_random.dirichlet
80-
mkl_random.interfaces.numpy_random.exponential
81-
mkl_random.interfaces.numpy_random.f
82-
mkl_random.interfaces.numpy_random.gamma
83-
mkl_random.interfaces.numpy_random.geometric
84-
mkl_random.interfaces.numpy_random.gumbel
85-
mkl_random.interfaces.numpy_random.hypergeometric
86-
mkl_random.interfaces.numpy_random.laplace
87-
mkl_random.interfaces.numpy_random.logistic
88-
mkl_random.interfaces.numpy_random.lognormal
89-
mkl_random.interfaces.numpy_random.logseries
90-
mkl_random.interfaces.numpy_random.multinomial
91-
mkl_random.interfaces.numpy_random.multivariate_normal
92-
mkl_random.interfaces.numpy_random.negative_binomial
93-
mkl_random.interfaces.numpy_random.noncentral_chisquare
94-
mkl_random.interfaces.numpy_random.noncentral_f
95-
mkl_random.interfaces.numpy_random.normal
96-
mkl_random.interfaces.numpy_random.pareto
97-
mkl_random.interfaces.numpy_random.poisson
98-
mkl_random.interfaces.numpy_random.power
99-
mkl_random.interfaces.numpy_random.rayleigh
100-
mkl_random.interfaces.numpy_random.standard_cauchy
101-
mkl_random.interfaces.numpy_random.standard_exponential
102-
mkl_random.interfaces.numpy_random.standard_gamma
103-
mkl_random.interfaces.numpy_random.standard_normal
104-
mkl_random.interfaces.numpy_random.standard_t
105-
mkl_random.interfaces.numpy_random.triangular
106-
mkl_random.interfaces.numpy_random.uniform
107-
mkl_random.interfaces.numpy_random.vonmises
108-
mkl_random.interfaces.numpy_random.wald
109-
mkl_random.interfaces.numpy_random.weibull
110-
mkl_random.interfaces.numpy_random.zipf
68+
.. autofunction:: mkl_random.interfaces.numpy_random.beta
69+
.. autofunction:: mkl_random.interfaces.numpy_random.binomial
70+
.. autofunction:: mkl_random.interfaces.numpy_random.chisquare
71+
.. autofunction:: mkl_random.interfaces.numpy_random.dirichlet
72+
.. autofunction:: mkl_random.interfaces.numpy_random.exponential
73+
.. autofunction:: mkl_random.interfaces.numpy_random.f
74+
.. autofunction:: mkl_random.interfaces.numpy_random.gamma
75+
.. autofunction:: mkl_random.interfaces.numpy_random.geometric
76+
.. autofunction:: mkl_random.interfaces.numpy_random.gumbel
77+
.. autofunction:: mkl_random.interfaces.numpy_random.hypergeometric
78+
.. autofunction:: mkl_random.interfaces.numpy_random.laplace
79+
.. autofunction:: mkl_random.interfaces.numpy_random.logistic
80+
.. autofunction:: mkl_random.interfaces.numpy_random.lognormal
81+
.. autofunction:: mkl_random.interfaces.numpy_random.logseries
82+
.. autofunction:: mkl_random.interfaces.numpy_random.multinomial
83+
.. autofunction:: mkl_random.interfaces.numpy_random.multivariate_normal
84+
.. autofunction:: mkl_random.interfaces.numpy_random.negative_binomial
85+
.. autofunction:: mkl_random.interfaces.numpy_random.noncentral_chisquare
86+
.. autofunction:: mkl_random.interfaces.numpy_random.noncentral_f
87+
.. autofunction:: mkl_random.interfaces.numpy_random.normal
88+
.. autofunction:: mkl_random.interfaces.numpy_random.pareto
89+
.. autofunction:: mkl_random.interfaces.numpy_random.poisson
90+
.. autofunction:: mkl_random.interfaces.numpy_random.power
91+
.. autofunction:: mkl_random.interfaces.numpy_random.rayleigh
92+
.. autofunction:: mkl_random.interfaces.numpy_random.standard_cauchy
93+
.. autofunction:: mkl_random.interfaces.numpy_random.standard_exponential
94+
.. autofunction:: mkl_random.interfaces.numpy_random.standard_gamma
95+
.. autofunction:: mkl_random.interfaces.numpy_random.standard_normal
96+
.. autofunction:: mkl_random.interfaces.numpy_random.standard_t
97+
.. autofunction:: mkl_random.interfaces.numpy_random.triangular
98+
.. autofunction:: mkl_random.interfaces.numpy_random.uniform
99+
.. autofunction:: mkl_random.interfaces.numpy_random.vonmises
100+
.. autofunction:: mkl_random.interfaces.numpy_random.wald
101+
.. autofunction:: mkl_random.interfaces.numpy_random.weibull
102+
.. autofunction:: mkl_random.interfaces.numpy_random.zipf

0 commit comments

Comments
 (0)