Skip to content

Commit

Permalink
WIP Try and get the stupid toctree working
Browse files Browse the repository at this point in the history
- It ain't working
  • Loading branch information
mofojed committed Mar 27, 2024
1 parent 501b71b commit fbaed39
Show file tree
Hide file tree
Showing 23 changed files with 206 additions and 1 deletion.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified plugins/ui/sphinx-docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified plugins/ui/sphinx-docs/_build/doctrees/index.doctree
Binary file not shown.
43 changes: 43 additions & 0 deletions plugins/ui/sphinx-docs/_build/markdown/components/buttons/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Buttons

Use buttons to display stuff

## Buttons

- [action_button]()
- [button](button.md)
- [button_group]()
- [toggle_button]()

## Inputs

- [checkbox]()
- [form]()
- [number_field]()
- [picker]()
- [range_slider]()
- [slider]()
- [switch]()
- [text_field]()

## Content

- [content]()
- [contextual_help]()
- [flex]()
- [grid]()
- [heading]()
- [icon]()
- [item]()
- [illustrated_message]()
- [table]()
- [tabs]()
- [view]()

## Layout

- [column]()
- [row]()
- [dashboard]()
- [stack]()
- [panel]()
49 changes: 49 additions & 0 deletions plugins/ui/sphinx-docs/_build/markdown/components/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Components

deephaven.ui provides many components to display in the UI. Use a component by assigning it to a variable, then display it in the UI.

```python
my_button = ui.button("Click Me!", on_press=lambda e: print(f"Button was clicked! {e}"))
```

Select any of the components below for API reference details. For examples and use cases, see the [examples]() page.

## Buttons

- [action_button]()
- [button]()
- [button_group]()
- [toggle_button]()

## Inputs

- [checkbox]()
- [form]()
- [number_field]()
- [picker]()
- [range_slider]()
- [slider]()
- [switch]()
- [text_field]()

## Content

- [content]()
- [contextual_help]()
- [flex]()
- [grid]()
- [heading]()
- [icon]()
- [item]()
- [illustrated_message]()
- [table]()
- [tabs]()
- [view]()

## Layout

- [column]()
- [row]()
- [dashboard]()
- [stack]()
- [panel]()
8 changes: 8 additions & 0 deletions plugins/ui/sphinx-docs/_build/markdown/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,14 @@ contain the root `toctree` directive. -->

# Welcome to deephaven’s documentation!

# Contents:

* [Components](components/index.md)
* [Buttons](components/index.md#buttons)
* [Inputs](components/index.md#inputs)
* [Content](components/index.md#content)
* [Layout](components/index.md#layout)

# Indices and tables

* [Index](genindex.md)
Expand Down
File renamed without changes.
47 changes: 47 additions & 0 deletions plugins/ui/sphinx-docs/components/buttons/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Buttons

Use buttons to display stuff

## Buttons

```{toctree}
```

- [action_button](action_button.md)
- [button](button.md)
- [button_group](button_group.md)
- [toggle_button](toggle_button.md)

## Inputs

- [checkbox](checkbox.md)
- [form](form.md)
- [number_field](number_field.md)
- [picker](picker.md)
- [range_slider](range_slider.md)
- [slider](slider.md)
- [switch](switch.md)
- [text_field](text_field.md)

## Content

- [content](content.md)
- [contextual_help](contextual_help.md)
- [flex](flex.md)
- [grid](grid.md)
- [heading](heading.md)
- [icon](icon.md)
- [item](item.md)
- [illustrated_message](illustrated_message.md)
- [table](table.md)
- [tabs](tabs.md)
- [view](view.md)

## Layout

- [column](column.md)
- [row](row.md)
- [dashboard](dashboard.md)
- [stack](stack.md)
- [panel](panel.md)
55 changes: 55 additions & 0 deletions plugins/ui/sphinx-docs/components/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Components

deephaven.ui provides many components to display in the UI. Use a component by assigning it to a variable, then display it in the UI.

```python
my_button = ui.button("Click Me!", on_press=lambda e: print(f"Button was clicked! {e}"))
```

Select any of the components below for API reference details. For examples and use cases, see the [examples](../examples) page.

## Buttons

<!-- TODO: How we get the toctree in .md here to show the buttons page? -->

```{toctree}
:maxdepth: 1
```

- [action_button](action_button.md)
- [button](button.md)
- [button_group](button_group.md)
- [toggle_button](toggle_button.md)

## Inputs

- [checkbox](checkbox.md)
- [form](form.md)
- [number_field](number_field.md)
- [picker](picker.md)
- [range_slider](range_slider.md)
- [slider](slider.md)
- [switch](switch.md)
- [text_field](text_field.md)

## Content

- [content](content.md)
- [contextual_help](contextual_help.md)
- [flex](flex.md)
- [grid](grid.md)
- [heading](heading.md)
- [icon](icon.md)
- [item](item.md)
- [illustrated_message](illustrated_message.md)
- [table](table.md)
- [tabs](tabs.md)
- [view](view.md)

## Layout

- [column](column.md)
- [row](row.md)
- [dashboard](dashboard.md)
- [stack](stack.md)
- [panel](panel.md)
5 changes: 4 additions & 1 deletion plugins/ui/sphinx-docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,10 @@ Welcome to deephaven's documentation!
:maxdepth: 4
:caption: Contents:

deephaven.ui
components/button
components
components/index
hooks


Indices and tables
Expand Down

0 comments on commit fbaed39

Please sign in to comment.