Skip to content

Commit b1b04bc

Browse files
wchwch
committed
Cleaner separation between quartodoc and quarto steps
1 parent dc0678a commit b1b04bc

File tree

4 files changed

+324
-332
lines changed

4 files changed

+324
-332
lines changed

‎docs/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@ api/
33
_inv/
44
_sidebar.yml
55
/.quarto/
6+
objects.json

‎docs/Makefile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ deps: $(PYBIN) ## Install build dependencies
4343
$(PYBIN)/pip install pip --upgrade
4444
$(PYBIN)/pip install -e ..[doc]
4545

46-
quartodoc: ## Build API docs
46+
quartodoc: ## Build qmd files for API docs
4747
. $(PYBIN)/activate \
4848
&& quartodoc interlinks \
49-
&& quartodoc build --verbose
49+
&& quartodoc build --config _quartodoc.yml --verbose
5050

5151
site: ## Build website
5252
. $(PYBIN)/activate \

‎docs/_quarto.yml‎

Lines changed: 1 addition & 330 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
project:
22
type: website
3-
# pre-render: version_config.py
43
output-dir: _site
54

65
format:
@@ -25,336 +24,8 @@ website:
2524
href: https://github.com/rstudio/py-shiny
2625
aria-label: Shiny for Python on GitHub
2726

28-
sidebar:
29-
- id: reference
30-
contents: "_sidebar.yml"
31-
32-
33-
quartodoc:
34-
style: pkgdown
35-
dir: api
36-
package: shiny
37-
rewrite_all_pages: false
38-
out_index: index.qmd
39-
sidebar: _sidebar.yml
40-
renderer:
41-
style: _renderer.py
42-
show_signature_annotations: false
43-
sections:
44-
- title: Page containers
45-
desc: Create a user interface page container.
46-
contents:
47-
- ui.page_navbar
48-
- ui.page_fluid
49-
- ui.page_fixed
50-
- ui.page_bootstrap
51-
- title: UI Layout
52-
desc: Control the layout of multiple UI components.
53-
contents:
54-
- ui.layout_sidebar
55-
- ui.panel_sidebar
56-
- ui.panel_main
57-
- ui.column
58-
- ui.row
59-
- title: UI Inputs
60-
desc: Create UI that prompts the user for input values or interaction.
61-
contents:
62-
- ui.input_select
63-
- ui.input_selectize
64-
- ui.input_slider
65-
- ui.input_date
66-
- ui.input_date_range
67-
- ui.input_checkbox
68-
- ui.input_checkbox_group
69-
- ui.input_switch
70-
- ui.input_radio_buttons
71-
- ui.input_numeric
72-
- ui.input_text
73-
- ui.input_text_area
74-
- ui.input_password
75-
- ui.input_action_button
76-
- ui.input_action_link
77-
- title: Update inputs
78-
desc: Programmatically update input values.
79-
contents:
80-
- name: ui.update_select
81-
dynamic: true
82-
- name: ui.update_selectize
83-
dynamic: true
84-
- name: ui.update_slider
85-
dynamic: true
86-
- ui.update_date
87-
- name: ui.update_date_range
88-
dynamic: true
89-
- name: ui.update_checkbox
90-
dynamic: true
91-
- name: ui.update_checkbox_group
92-
dynamic: true
93-
- name: ui.update_switch
94-
dynamic: true
95-
- name: ui.update_radio_buttons
96-
dynamic: true
97-
- name: ui.update_numeric
98-
dynamic: true
99-
- ui.update_text
100-
- name: ui.update_text_area
101-
dynamic: "shiny.ui.update_text"
102-
- name: ui.update_navs
103-
dynamic: true
104-
- title: Navigation (tab) panels
105-
desc: Create segments of UI content.
106-
contents:
107-
- ui.nav
108-
- ui.nav_control
109-
- ui.nav_spacer
110-
- ui.nav_menu
111-
- ui.navset_tab
112-
- ui.navset_tab_card
113-
- ui.navset_pill
114-
- ui.navset_pill_card
115-
- ui.navset_pill_list
116-
- ui.navset_hidden
117-
- title: UI panels
118-
desc: Visually group together a section of UI components.
119-
contents:
120-
- ui.panel_absolute
121-
- ui.panel_fixed
122-
- ui.panel_conditional
123-
- ui.panel_title
124-
- ui.panel_well
125-
- title: Uploads & downloads
126-
desc: Allow users to upload and download files.
127-
contents:
128-
- ui.input_file
129-
- ui.download_button
130-
- title: Custom UI
131-
desc: Lower-level UI functions for creating custom HTML/CSS/JS
132-
contents:
133-
- ui.HTML # uses justattributes.rst template
134-
- ui.TagList # uses class.rst template
135-
- name: ui.tags # uses tags.rst template
136-
children: embedded
137-
- ui.markdown
138-
- ui.include_css
139-
- ui.include_js
140-
- ui.insert_ui
141-
- ui.remove_ui
142-
- title: Rendering outputs
143-
desc: "UI (output_*()) and server (render)ing functions for generating content server-side."
144-
contents:
145-
- ui.output_plot
146-
- ui.output_image
147-
- ui.output_table
148-
- ui.output_data_frame
149-
- ui.output_text
150-
- ui.output_text_verbatim
151-
- ui.output_ui
152-
- render.plot
153-
- render.image
154-
- render.table
155-
- render.text
156-
- render.ui
157-
- render.data_frame
158-
- render.DataGrid
159-
- render.DataTable
160-
- title: Reactive programming
161-
desc: ""
162-
contents:
163-
- reactive.Calc
164-
- reactive.Effect
165-
- reactive.Value
166-
- reactive.event
167-
- reactive.isolate
168-
- reactive.invalidate_later
169-
- reactive.flush
170-
- reactive.poll
171-
- reactive.file_reader
172-
- reactive.lock
173-
- req
174-
- title: Create and run applications
175-
desc: ""
176-
contents:
177-
- run_app
178-
# uses class.rst template
179-
- App
180-
- Inputs
181-
- Outputs
182-
- Session
183-
- title: Display messages
184-
desc: ""
185-
contents:
186-
- ui.help_text
187-
- ui.notification_show
188-
- ui.notification_remove
189-
- ui.modal
190-
- ui.modal_show
191-
- ui.modal_remove
192-
- ui.modal_button
193-
- ui.Progress # uses class.rst
194-
- title: Modules
195-
desc: ""
196-
contents:
197-
# uses class.rst template
198-
- module.ui
199-
- module.server
200-
- title: Developer facing tools
201-
desc: ""
202-
contents:
203-
- session.get_current_session
204-
- session.require_active_session
205-
- session.session_context
206-
- reactive.get_current_context
207-
- name: input_handler.input_handlers
208-
dynamic: true
209-
- title: Types
210-
desc: ""
211-
contents:
212-
- kind: page
213-
path: MiscTypes.html
214-
flatten: true
215-
summary:
216-
name: "Miscellaneous types"
217-
desc: ""
218-
contents:
219-
- types.MISSING_TYPE
220-
- types.MISSING
221-
- types.FileInfo
222-
- types.ImgData
223-
- types.NavSetArg
224-
- ui._input_slider.SliderValueArg
225-
- ui._input_slider.SliderStepArg
226-
- kind: page
227-
path: TagTypes.html
228-
summary:
229-
name: "Tag types"
230-
desc: ""
231-
flatten: true
232-
package: null
233-
contents:
234-
- htmltools.Tag
235-
- htmltools.TagAttrs
236-
- htmltools.TagAttrValue
237-
- htmltools.TagChild
238-
- htmltools.TagList
239-
- kind: page
240-
path: ExceptionTypes.html
241-
summary:
242-
name: "Exception types"
243-
desc: ""
244-
flatten: true
245-
contents:
246-
- types.SilentException
247-
- types.SilentCancelOutputException
248-
- types.SafeException
249-
# - title: Experimental
250-
# desc: "These methods are under consideration and are considered unstable. However, if there is a method you are excited about, please let us know!"
251-
# contents:
252-
# - kind: page
253-
# path: ExSidebar
254-
# desc: "Methods related to adding a sidebar to a page or Card"
255-
# summary:
256-
# name: "Sidebar"
257-
# desc: "Sidebar layouts allow users to easily access filters, settings, and other inputs alongside interactive features they control."
258-
# flatten: true
259-
# contents:
260-
# - experimental.ui.page_sidebar
261-
# - experimental.ui.sidebar
262-
# - experimental.ui.layout_sidebar
263-
# - experimental.ui.page_navbar
264-
# - experimental.ui.navset_bar
265-
# - experimental.ui.navset_tab_card
266-
# - experimental.ui.navset_pill_card
267-
# - experimental.ui.sidebar_toggle
268-
# - experimental.ui.panel_main
269-
# - experimental.ui.panel_sidebar
270-
# - experimental.ui.Sidebar
271-
# - experimental.ui.DeprecatedPanelMain
272-
# - experimental.ui.DeprecatedPanelSidebar
273-
# - kind: page
274-
# path: ExCard
275-
# summary:
276-
# name: "Card"
277-
# desc: "Cards are a common organizing unit for modern user interfaces (UI). At their core, they’re just rectangular containers with borders and padding. However, when utilized properly to group related information, they help users better digest, engage, and navigate through content."
278-
# flatten: true
279-
# contents:
280-
# - experimental.ui.card
281-
# - experimental.ui.card_header
282-
# - experimental.ui.card_title
283-
# - experimental.ui.card_body
284-
# - experimental.ui.card_image
285-
# - experimental.ui.card_footer
286-
# - experimental.ui.CardItem
287-
# - experimental.ui.ImgContainer
288-
# - experimental.ui.TagCallable
289-
# - experimental.ui.WrapperCallable
290-
# - kind: page
291-
# path: ExAccordionPanels
292-
# summary:
293-
# name: "Accordion panels"
294-
# desc: "Methods related to creating and updating vertically collapsing accordion panels."
295-
# flatten: true
296-
# contents:
297-
# - experimental.ui.accordion
298-
# - experimental.ui.accordion_panel
299-
# - experimental.ui.accordion_panel_set
300-
# - experimental.ui.accordion_panel_open
301-
# - experimental.ui.accordion_panel_close
302-
# - experimental.ui.accordion_panel_insert
303-
# - experimental.ui.accordion_panel_remove
304-
# - experimental.ui.update_accordion_panel
305-
# - experimental.ui.AccordionPanel
306-
# - kind: page
307-
# path: ExValueBoxes
308-
# summary:
309-
# name: "Value boxes"
310-
# desc: "Prominently display a value and label in a box that can be expanded to show more information."
311-
# flatten: true
312-
# contents:
313-
# - experimental.ui.value_box
314-
# - experimental.ui.showcase_left_center
315-
# - experimental.ui.showcase_top_right
316-
# - kind: page
317-
# path: ExFillingLayout
318-
# summary:
319-
# name: "Filling layouts"
320-
# desc: "Methods to create containers that are allowed to shrink or expand available space."
321-
# flatten: true
322-
# contents:
323-
# - experimental.ui.page_fillable
324-
# - experimental.ui.layout_column_wrap
325-
# - experimental.ui.as_fill_carrier
326-
# - experimental.ui.as_fillable_container
327-
# - experimental.ui.as_fill_item
328-
# - experimental.ui.remove_all_fill
329-
# - experimental.ui.is_fill_carrier
330-
# - experimental.ui.is_fillable_container
331-
# - experimental.ui.is_fill_item
332-
# - experimental.ui.FillingLayout
333-
# - experimental.ui.output_image
334-
# - experimental.ui.output_plot
335-
# - experimental.ui.output_ui
336-
# - kind: page
337-
# path: ExUiInputs
338-
# summary:
339-
# name: "UI Inputs"
340-
# desc: "Additional or upgraded UI inputs."
341-
# flatten: true
342-
# contents:
343-
# - experimental.ui.input_text_area
344-
# - kind: page
345-
# path: ExCss
346-
# desc: "Helper methods related to CSS."
347-
# summary:
348-
# name: "Css"
349-
# desc: "Helper methods related to CSS."
350-
# flatten: true
351-
# contents:
352-
# - experimental.ui.as_css_unit
353-
# - experimental.ui.as_css_padding
354-
# - experimental.ui.CssUnit
355-
35627
metadata-files:
357-
- _sidebar.yml
28+
- api/_sidebar.yml
35829

35930
filters:
36031
- shinylive

0 commit comments

Comments
 (0)