Skip to content

Commit ad41027

Browse files
RaghuSpaceRajanRaghuSpaceRajan
authored
Merge pull request #2 from RaghuSpaceRajan/dev/jan
Merge sphinx automatic documentation changes from Jan's work
2 parents e350c5e + 3a938a7 commit ad41027

File tree

70 files changed

+2943
-65
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+2943
-65
lines changed

‎docs/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/_autosummary/mdp_playground.analysis.MDPP_Analysis.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
mdp\_playground.analysis.MDPP\_Analysis
2+
=======================================
3+
4+
.. currentmodule:: mdp_playground.analysis
5+
6+
.. autoclass:: MDPP_Analysis
7+
:members: <-- add at least this line
8+
:show-inheritance: <-- plus I want to show inheritance...
9+
:inherited-members: <-- ...and inherited members too
10+
11+
12+
.. automethod:: __init__
13+
14+
15+
.. rubric:: Methods
16+
17+
.. autosummary::
18+
19+
~MDPP_Analysis.__init__
20+
~MDPP_Analysis.gather_stats
21+
~MDPP_Analysis.get_exp_data
22+
~MDPP_Analysis.load_data
23+
~MDPP_Analysis.plot_1d_dimensions
24+
~MDPP_Analysis.plot_2d_heatmap
25+
~MDPP_Analysis.plot_bar
26+
~MDPP_Analysis.plot_learning_curves
27+
~MDPP_Analysis.plot_radar
28+
29+
30+
31+
32+
33+

‎docs/_autosummary/mdp_playground.analysis.analysis.MDPP_Analysis.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
mdp\_playground.analysis.analysis.MDPP\_Analysis
2+
================================================
3+
4+
.. currentmodule:: mdp_playground.analysis.analysis
5+
6+
.. autoclass:: MDPP_Analysis
7+
:members: <-- add at least this line
8+
:show-inheritance: <-- plus I want to show inheritance...
9+
:inherited-members: <-- ...and inherited members too
10+
11+
12+
.. automethod:: __init__
13+
14+
15+
.. rubric:: Methods
16+
17+
.. autosummary::
18+
19+
~MDPP_Analysis.__init__
20+
~MDPP_Analysis.gather_stats
21+
~MDPP_Analysis.get_exp_data
22+
~MDPP_Analysis.load_data
23+
~MDPP_Analysis.plot_1d_dimensions
24+
~MDPP_Analysis.plot_2d_heatmap
25+
~MDPP_Analysis.plot_bar
26+
~MDPP_Analysis.plot_learning_curves
27+
~MDPP_Analysis.plot_radar
28+
29+
30+
31+
32+
33+

‎docs/_autosummary/mdp_playground.analysis.analysis.rst

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
mdp\_playground.analysis.analysis
2+
=================================
3+
4+
.. automodule:: mdp_playground.analysis.analysis
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Classes
17+
18+
.. autosummary::
19+
:toctree:
20+
:template: custom-class-template.rst
21+
22+
MDPP_Analysis
23+
24+
25+
26+
27+
28+
29+
30+
31+

‎docs/_autosummary/mdp_playground.analysis.radar_chart.Affine2D.rst

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
mdp\_playground.analysis.radar\_chart.Affine2D
2+
==============================================
3+
4+
.. currentmodule:: mdp_playground.analysis.radar_chart
5+
6+
.. autoclass:: Affine2D
7+
:members: <-- add at least this line
8+
:show-inheritance: <-- plus I want to show inheritance...
9+
:inherited-members: <-- ...and inherited members too
10+
11+
12+
.. automethod:: __init__
13+
14+
15+
.. rubric:: Methods
16+
17+
.. autosummary::
18+
19+
~Affine2D.__init__
20+
~Affine2D.clear
21+
~Affine2D.contains_branch
22+
~Affine2D.contains_branch_seperately
23+
~Affine2D.from_values
24+
~Affine2D.frozen
25+
~Affine2D.get_affine
26+
~Affine2D.get_matrix
27+
~Affine2D.identity
28+
~Affine2D.invalidate
29+
~Affine2D.inverted
30+
~Affine2D.matrix_from_values
31+
~Affine2D.rotate
32+
~Affine2D.rotate_around
33+
~Affine2D.rotate_deg
34+
~Affine2D.rotate_deg_around
35+
~Affine2D.scale
36+
~Affine2D.set
37+
~Affine2D.set_children
38+
~Affine2D.set_matrix
39+
~Affine2D.skew
40+
~Affine2D.skew_deg
41+
~Affine2D.to_values
42+
~Affine2D.transform
43+
~Affine2D.transform_affine
44+
~Affine2D.transform_angles
45+
~Affine2D.transform_bbox
46+
~Affine2D.transform_non_affine
47+
~Affine2D.transform_path
48+
~Affine2D.transform_path_affine
49+
~Affine2D.transform_path_non_affine
50+
~Affine2D.transform_point
51+
~Affine2D.translate
52+
53+
54+
55+
56+
57+
.. rubric:: Attributes
58+
59+
.. autosummary::
60+
61+
~Affine2D.INVALID
62+
~Affine2D.INVALID_AFFINE
63+
~Affine2D.INVALID_NON_AFFINE
64+
~Affine2D.depth
65+
~Affine2D.has_inverse
66+
~Affine2D.input_dims
67+
~Affine2D.is_affine
68+
~Affine2D.is_bbox
69+
~Affine2D.is_separable
70+
~Affine2D.output_dims
71+
~Affine2D.pass_through
72+
73+

‎docs/_autosummary/mdp_playground.analysis.radar_chart.Circle.rst

Lines changed: 152 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
1+
mdp\_playground.analysis.radar\_chart.Circle
2+
============================================
3+
4+
.. currentmodule:: mdp_playground.analysis.radar_chart
5+
6+
.. autoclass:: Circle
7+
:members: <-- add at least this line
8+
:show-inheritance: <-- plus I want to show inheritance...
9+
:inherited-members: <-- ...and inherited members too
10+
11+
12+
.. automethod:: __init__
13+
14+
15+
.. rubric:: Methods
16+
17+
.. autosummary::
18+
19+
~Circle.__init__
20+
~Circle.add_callback
21+
~Circle.contains
22+
~Circle.contains_point
23+
~Circle.contains_points
24+
~Circle.convert_xunits
25+
~Circle.convert_yunits
26+
~Circle.draw
27+
~Circle.findobj
28+
~Circle.format_cursor_data
29+
~Circle.get_aa
30+
~Circle.get_agg_filter
31+
~Circle.get_alpha
32+
~Circle.get_angle
33+
~Circle.get_animated
34+
~Circle.get_antialiased
35+
~Circle.get_capstyle
36+
~Circle.get_center
37+
~Circle.get_children
38+
~Circle.get_clip_box
39+
~Circle.get_clip_on
40+
~Circle.get_clip_path
41+
~Circle.get_contains
42+
~Circle.get_cursor_data
43+
~Circle.get_data_transform
44+
~Circle.get_ec
45+
~Circle.get_edgecolor
46+
~Circle.get_extents
47+
~Circle.get_facecolor
48+
~Circle.get_fc
49+
~Circle.get_figure
50+
~Circle.get_fill
51+
~Circle.get_gid
52+
~Circle.get_hatch
53+
~Circle.get_height
54+
~Circle.get_in_layout
55+
~Circle.get_joinstyle
56+
~Circle.get_label
57+
~Circle.get_linestyle
58+
~Circle.get_linewidth
59+
~Circle.get_ls
60+
~Circle.get_lw
61+
~Circle.get_patch_transform
62+
~Circle.get_path
63+
~Circle.get_path_effects
64+
~Circle.get_picker
65+
~Circle.get_radius
66+
~Circle.get_rasterized
67+
~Circle.get_sketch_params
68+
~Circle.get_snap
69+
~Circle.get_tightbbox
70+
~Circle.get_transform
71+
~Circle.get_transformed_clip_path_and_affine
72+
~Circle.get_url
73+
~Circle.get_verts
74+
~Circle.get_visible
75+
~Circle.get_width
76+
~Circle.get_window_extent
77+
~Circle.get_zorder
78+
~Circle.have_units
79+
~Circle.is_transform_set
80+
~Circle.pchanged
81+
~Circle.pick
82+
~Circle.pickable
83+
~Circle.properties
84+
~Circle.remove
85+
~Circle.remove_callback
86+
~Circle.set
87+
~Circle.set_aa
88+
~Circle.set_agg_filter
89+
~Circle.set_alpha
90+
~Circle.set_angle
91+
~Circle.set_animated
92+
~Circle.set_antialiased
93+
~Circle.set_capstyle
94+
~Circle.set_center
95+
~Circle.set_clip_box
96+
~Circle.set_clip_on
97+
~Circle.set_clip_path
98+
~Circle.set_color
99+
~Circle.set_contains
100+
~Circle.set_ec
101+
~Circle.set_edgecolor
102+
~Circle.set_facecolor
103+
~Circle.set_fc
104+
~Circle.set_figure
105+
~Circle.set_fill
106+
~Circle.set_gid
107+
~Circle.set_hatch
108+
~Circle.set_height
109+
~Circle.set_in_layout
110+
~Circle.set_joinstyle
111+
~Circle.set_label
112+
~Circle.set_linestyle
113+
~Circle.set_linewidth
114+
~Circle.set_ls
115+
~Circle.set_lw
116+
~Circle.set_path_effects
117+
~Circle.set_picker
118+
~Circle.set_radius
119+
~Circle.set_rasterized
120+
~Circle.set_sketch_params
121+
~Circle.set_snap
122+
~Circle.set_transform
123+
~Circle.set_url
124+
~Circle.set_visible
125+
~Circle.set_width
126+
~Circle.set_zorder
127+
~Circle.update
128+
~Circle.update_from
129+
130+
131+
132+
133+
134+
.. rubric:: Attributes
135+
136+
.. autosummary::
137+
138+
~Circle.angle
139+
~Circle.axes
140+
~Circle.center
141+
~Circle.fill
142+
~Circle.height
143+
~Circle.mouseover
144+
~Circle.radius
145+
~Circle.stale
146+
~Circle.sticky_edges
147+
~Circle.validCap
148+
~Circle.validJoin
149+
~Circle.width
150+
~Circle.zorder
151+
152+

0 commit comments

Comments
 (0)