Skip to content

Commit 5fe1235

Browse files
Sheppard, KevinSheppard, Kevin
Sheppard, Kevin
authored and
Sheppard, Kevin
committed
DOC: Improve documentation
Use NumPy's random doc as a template for all PRNG Fix small doc string issue in mlfg Add relevant papers for sequences [skip ci]
1 parent 477671f commit 5fe1235

File tree

17 files changed

+642
-33
lines changed

17 files changed

+642
-33
lines changed

‎doc/source/conf.py‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
'sphinx.ext.todo',
3636
'sphinx.ext.mathjax',
3737
'sphinx.ext.napoleon',
38+
'sphinx.ext.autosummary',
3839
]
3940

4041
# Add any paths that contain templates here, relative to this directory.
@@ -293,3 +294,5 @@
293294

294295
# If true, do not generate a @detailmenu in the "Top" node's menu.
295296
#texinfo_no_detailmenu = False
297+
298+
autosummary_generate = True

‎doc/source/dsfmt.rst‎

Lines changed: 79 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,82 @@
11
dSFMT Randomstate
2-
=================
2+
*****************
33

4-
.. py:currentmodule:: randomstate.prng.dsfmt
4+
.. currentmodule:: randomstate.prng.dsfmt
55

6-
.. autoclass:: RandomState
7-
:members:
6+
Random generator
7+
================
8+
.. autoclass::
9+
RandomState
10+
11+
.. autosummary::
12+
:toctree: generated/
13+
14+
seed
15+
get_state
16+
set_state
17+
18+
19+
Simple random data
20+
==================
21+
.. autosummary::
22+
:toctree: generated/
23+
24+
rand
25+
randn
26+
randint
27+
random_integers
28+
random_sample
29+
random
30+
ranf
31+
sample
32+
choice
33+
bytes
34+
35+
Permutations
36+
============
37+
.. autosummary::
38+
:toctree: generated/
39+
40+
shuffle
41+
permutation
42+
43+
Distributions
44+
=============
45+
.. autosummary::
46+
:toctree: generated/
47+
48+
beta
49+
binomial
50+
chisquare
51+
dirichlet
52+
exponential
53+
f
54+
gamma
55+
geometric
56+
gumbel
57+
hypergeometric
58+
laplace
59+
logistic
60+
lognormal
61+
logseries
62+
multinomial
63+
multivariate_normal
64+
negative_binomial
65+
noncentral_chisquare
66+
noncentral_f
67+
normal
68+
pareto
69+
poisson
70+
power
71+
rayleigh
72+
standard_cauchy
73+
standard_exponential
74+
standard_gamma
75+
standard_normal
76+
standard_t
77+
triangular
78+
uniform
79+
vonmises
80+
wald
81+
weibull
82+
zipf

‎doc/source/mlfg.rst‎

Lines changed: 79 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,82 @@
11
MLFG(1279, 861, \*) Randomstate
2-
================================
2+
********************************
33

4-
.. py:currentmodule:: randomstate.prng.mlfg_1279_861
4+
.. currentmodule:: randomstate.prng.mlfg_1279_861
55

6-
.. autoclass:: RandomState
7-
:members:
6+
Random generator
7+
================
8+
.. autoclass::
9+
RandomState
10+
11+
.. autosummary::
12+
:toctree: generated/
13+
14+
seed
15+
get_state
16+
set_state
17+
18+
19+
Simple random data
20+
==================
21+
.. autosummary::
22+
:toctree: generated/
23+
24+
rand
25+
randn
26+
randint
27+
random_integers
28+
random_sample
29+
random
30+
ranf
31+
sample
32+
choice
33+
bytes
34+
35+
Permutations
36+
============
37+
.. autosummary::
38+
:toctree: generated/
39+
40+
shuffle
41+
permutation
42+
43+
Distributions
44+
=============
45+
.. autosummary::
46+
:toctree: generated/
47+
48+
beta
49+
binomial
50+
chisquare
51+
dirichlet
52+
exponential
53+
f
54+
gamma
55+
geometric
56+
gumbel
57+
hypergeometric
58+
laplace
59+
logistic
60+
lognormal
61+
logseries
62+
multinomial
63+
multivariate_normal
64+
negative_binomial
65+
noncentral_chisquare
66+
noncentral_f
67+
normal
68+
pareto
69+
poisson
70+
power
71+
rayleigh
72+
standard_cauchy
73+
standard_exponential
74+
standard_gamma
75+
standard_normal
76+
standard_t
77+
triangular
78+
uniform
79+
vonmises
80+
wald
81+
weibull
82+
zipf

‎doc/source/mrg32k3a.rst‎

Lines changed: 80 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,83 @@
11
MRG32K3A Randomstate
2-
====================
2+
********************
33

4-
.. py:currentmodule:: randomstate.prng.mrg32k3a
4+
.. currentmodule:: randomstate.prng.mrg32k3a
55

6-
.. autoclass:: RandomState
7-
:members:
6+
7+
Random generator
8+
================
9+
.. autoclass::
10+
RandomState
11+
12+
.. autosummary::
13+
:toctree: generated/
14+
15+
seed
16+
get_state
17+
set_state
18+
19+
20+
Simple random data
21+
==================
22+
.. autosummary::
23+
:toctree: generated/
24+
25+
rand
26+
randn
27+
randint
28+
random_integers
29+
random_sample
30+
random
31+
ranf
32+
sample
33+
choice
34+
bytes
35+
36+
Permutations
37+
============
38+
.. autosummary::
39+
:toctree: generated/
40+
41+
shuffle
42+
permutation
43+
44+
Distributions
45+
=============
46+
.. autosummary::
47+
:toctree: generated/
48+
49+
beta
50+
binomial
51+
chisquare
52+
dirichlet
53+
exponential
54+
f
55+
gamma
56+
geometric
57+
gumbel
58+
hypergeometric
59+
laplace
60+
logistic
61+
lognormal
62+
logseries
63+
multinomial
64+
multivariate_normal
65+
negative_binomial
66+
noncentral_chisquare
67+
noncentral_f
68+
normal
69+
pareto
70+
poisson
71+
power
72+
rayleigh
73+
standard_cauchy
74+
standard_exponential
75+
standard_gamma
76+
standard_normal
77+
standard_t
78+
triangular
79+
uniform
80+
vonmises
81+
wald
82+
weibull
83+
zipf

‎doc/source/mt19937.rst‎

Lines changed: 80 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,83 @@
11
MT19937 Randomstate
2-
===================
2+
*******************
33

4-
.. py:currentmodule:: randomstate.prng.mt19937
4+
.. currentmodule:: randomstate.prng.mt19937
55

6-
.. autoclass:: RandomState
7-
:members:
6+
7+
Random generator
8+
================
9+
.. autoclass::
10+
RandomState
11+
12+
.. autosummary::
13+
:toctree: generated/
14+
15+
seed
16+
get_state
17+
set_state
18+
19+
20+
Simple random data
21+
==================
22+
.. autosummary::
23+
:toctree: generated/
24+
25+
rand
26+
randn
27+
randint
28+
random_integers
29+
random_sample
30+
random
31+
ranf
32+
sample
33+
choice
34+
bytes
35+
36+
Permutations
37+
============
38+
.. autosummary::
39+
:toctree: generated/
40+
41+
shuffle
42+
permutation
43+
44+
Distributions
45+
=============
46+
.. autosummary::
47+
:toctree: generated/
48+
49+
beta
50+
binomial
51+
chisquare
52+
dirichlet
53+
exponential
54+
f
55+
gamma
56+
geometric
57+
gumbel
58+
hypergeometric
59+
laplace
60+
logistic
61+
lognormal
62+
logseries
63+
multinomial
64+
multivariate_normal
65+
negative_binomial
66+
noncentral_chisquare
67+
noncentral_f
68+
normal
69+
pareto
70+
poisson
71+
power
72+
rayleigh
73+
standard_cauchy
74+
standard_exponential
75+
standard_gamma
76+
standard_normal
77+
standard_t
78+
triangular
79+
uniform
80+
vonmises
81+
wald
82+
weibull
83+
zipf

0 commit comments

Comments
 (0)