Skip to content

Commit 373ca19

Browse files
committed
Move away dynamic rst and towards static numpydoc
1 parent 04248bf commit 373ca19

27 files changed

+2774
-1269
lines changed

docs/source/api.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/source/index.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

docs/source/index.rst

Lines changed: 229 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,229 @@
1+
Shiny for Python API Reference
2+
================
3+
4+
* :ref:`search`
5+
6+
7+
Page containers
8+
~~~~~~~~~~~~~~~
9+
10+
Create a user interface page container.
11+
12+
.. autosummary::
13+
:toctree: reference/
14+
15+
~shiny.ui.page_navbar
16+
~shiny.ui.page_fluid
17+
~shiny.ui.page_fixed
18+
~shiny.ui.page_bootstrap
19+
20+
21+
UI Layout
22+
~~~~~~~~~
23+
24+
Control the layout of multiple UI components.
25+
26+
.. autosummary::
27+
:toctree: reference/
28+
29+
~shiny.ui.layout_sidebar
30+
~shiny.ui.panel_sidebar
31+
~shiny.ui.panel_main
32+
~shiny.ui.column
33+
~shiny.ui.row
34+
35+
UI Inputs
36+
~~~~~~~~~
37+
38+
Create UI that prompts the user for input values or interaction.
39+
40+
.. autosummary::
41+
:toctree: reference/
42+
43+
~shiny.ui.input_select
44+
~shiny.ui.input_selectize
45+
~shiny.ui.input_slider
46+
~shiny.ui.input_date
47+
~shiny.ui.input_date_range
48+
~shiny.ui.input_checkbox
49+
~shiny.ui.input_checkbox_group
50+
~shiny.ui.input_radio_buttons
51+
~shiny.ui.input_numeric
52+
~shiny.ui.input_text
53+
~shiny.ui.input_text_area
54+
~shiny.ui.input_password
55+
~shiny.ui.input_action_button
56+
57+
58+
Update inputs
59+
~~~~~~~~~~~~~
60+
61+
Programmatically update input values
62+
63+
.. autosummary::
64+
:toctree: reference/
65+
66+
~shiny.ui.update_select
67+
~shiny.ui.update_slider
68+
~shiny.ui.update_date
69+
~shiny.ui.update_date_range
70+
~shiny.ui.update_checkbox
71+
~shiny.ui.update_checkbox_group
72+
~shiny.ui.update_radio_buttons
73+
~shiny.ui.update_numeric
74+
~shiny.ui.update_text
75+
~shiny.ui.update_text_area
76+
~shiny.ui.update_navs
77+
78+
79+
Navigation (tab) panels
80+
~~~~~~~~~~~~~~~~~~~~~~~
81+
82+
Create segments of UI content.
83+
84+
.. autosummary::
85+
:toctree: reference/
86+
87+
~shiny.ui.nav
88+
~shiny.ui.nav_item
89+
~shiny.ui.nav_spacer
90+
~shiny.ui.nav_menu
91+
~shiny.ui.navs_tab
92+
~shiny.ui.navs_tab_card
93+
~shiny.ui.navs_pill
94+
~shiny.ui.navs_pill_card
95+
~shiny.ui.navs_pill_list
96+
97+
98+
UI panels
99+
~~~~~~~~~
100+
101+
Visually group together a section of UI components.
102+
103+
.. autosummary::
104+
:toctree: reference/
105+
106+
~shiny.ui.panel_absolute
107+
~shiny.ui.panel_fixed
108+
~shiny.ui.panel_conditional
109+
~shiny.ui.panel_title
110+
~shiny.ui.panel_well
111+
112+
113+
Uploads & downloads
114+
~~~~~~~~~~~~~~~~~~~
115+
116+
Allows users to upload and download files.
117+
118+
.. autosummary::
119+
:toctree: reference/
120+
121+
~shiny.ui.input_file
122+
~shiny.ui.download_button
123+
124+
125+
Custom UI
126+
~~~~~~~~~~
127+
128+
Lower-level UI functions for creating custom HTML/CSS/JS.
129+
130+
.. autosummary::
131+
:toctree: reference/
132+
133+
~shiny.ui.HTML
134+
~shiny.ui.tags
135+
~shiny.ui.TagList
136+
~shiny.ui.insert_ui
137+
~shiny.ui.remove_ui
138+
139+
140+
Rendering outputs
141+
~~~~~~~~~~~~~~~~~~
142+
143+
UI (`output_*()`) and server (``render_*()``) functions for generating content server-side.
144+
145+
.. autosummary::
146+
:toctree: reference/
147+
148+
~shiny.ui.output_plot
149+
~shiny.render_plot
150+
~shiny.ui.output_image
151+
~shiny.render_image
152+
~shiny.ui.output_text
153+
~shiny.ui.output_text_verbatim
154+
~shiny.render_text
155+
~shiny.ui.output_ui
156+
~shiny.render_ui
157+
158+
159+
Reactive programming
160+
~~~~~~~~~~~~~~~~~~
161+
162+
Reactive programming facilities for Python.
163+
164+
.. autosummary::
165+
:toctree: reference/
166+
167+
~shiny.reactive.Calc
168+
~shiny.reactive.Effect
169+
~shiny.reactive.Value
170+
~shiny.reactive.isolate
171+
~shiny.reactive.invalidate_later
172+
~shiny.reactive.flush
173+
~shiny.event
174+
175+
176+
Create and run applications
177+
~~~~~~~~~~~~~~~~~~~~~~~~~~~
178+
179+
Create, run, stop, and hook into the lifecycle of Shiny applications.
180+
181+
.. autosummary::
182+
:toctree: reference/
183+
184+
~shiny.App
185+
~shiny.run_app
186+
187+
Display messages
188+
~~~~~~~~~~~~~~~~
189+
190+
Display messages to the user.
191+
192+
.. autosummary::
193+
:toctree: reference/
194+
195+
~shiny.ui.help_text
196+
~shiny.ui.notification_show
197+
~shiny.ui.notification_remove
198+
~shiny.ui.Progress
199+
~shiny.ui.modal
200+
~shiny.ui.modal_show
201+
~shiny.ui.modal_remove
202+
~shiny.ui.modal_button
203+
204+
Error validation
205+
~~~~~~~~~~~~~~~~
206+
207+
Control how errors are shown to the user.
208+
209+
.. autosummary::
210+
:toctree: reference/
211+
212+
~shiny.req
213+
~shiny.types.SilentException
214+
~shiny.types.SilentCancelOutputException
215+
~shiny.types.SafeException
216+
217+
218+
Modules
219+
~~~~~~~
220+
221+
Control application complexity by namespacing UI and server code.
222+
223+
.. autosummary::
224+
:toctree: reference/
225+
226+
~shiny.modules.Module
227+
~shiny.modules.ModuleInputs
228+
~shiny.modules.ModuleOutputs
229+
~shiny.modules.ModuleSession

0 commit comments

Comments
 (0)