Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Add py.cafe to the docs examples #569

Merged
merged 86 commits into from
Aug 15, 2024
Merged
Changes from 1 commit
Commits
Show all changes
86 commits
Select commit Hold shift + click to select a range
868e7d1
First docs proposal
maxschulz-COL Jul 5, 2024
d89c274
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 5, 2024
4d70c90
Merge branch 'main' into docs/pycafe_embedding
maxschulz-COL Jul 22, 2024
749e66b
Try out the new mkdocs plugin
maxschulz-COL Jul 30, 2024
9578ebd
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jul 30, 2024
5dee5cc
Merge branch 'main' into docs/pycafe_embedding
maxschulz-COL Aug 1, 2024
1438caf
Update first tutorial
stichbury Aug 6, 2024
4d3bf78
Add py.cafe logo
stichbury Aug 6, 2024
d6429a1
Swap ordering of onboarding pages
stichbury Aug 7, 2024
95a8167
Update first-dashboard.md
stichbury Aug 7, 2024
baacd96
Update install.md
stichbury Aug 7, 2024
bf7c22c
Linting
stichbury Aug 7, 2024
49a00f5
Update explore-components.md
stichbury Aug 7, 2024
238dfc3
Merge branch 'main' into docs/pycafe_embedding
stichbury Aug 7, 2024
5ec800c
Update index.md
stichbury Aug 7, 2024
032e1ec
Merge branch 'docs/pycafe_embedding' of https://github.com/mckinsey/v…
stichbury Aug 7, 2024
4cec06e
Update first-dashboard.md
stichbury Aug 7, 2024
9242846
Vale
stichbury Aug 7, 2024
5427de0
Fundamentals section
stichbury Aug 7, 2024
4d7db62
Vale
stichbury Aug 7, 2024
cd77c4a
Update figure.md
stichbury Aug 7, 2024
4e366c0
Update graph.md
stichbury Aug 7, 2024
d7f15e0
Update table.md
stichbury Aug 7, 2024
cf75356
Update figure.md
stichbury Aug 7, 2024
f39f722
Update card-button.md
stichbury Aug 7, 2024
26cdd61
Update container.md
stichbury Aug 7, 2024
28bd661
Update tabs.md
stichbury Aug 7, 2024
865065c
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 7, 2024
77230b3
Update filters.md
stichbury Aug 7, 2024
bec9057
Merge branch 'docs/pycafe_embedding' of https://github.com/mckinsey/v…
stichbury Aug 7, 2024
f485422
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 7, 2024
0307b2a
Update parameters.md
stichbury Aug 7, 2024
ddb3dd2
Update selectors.md
stichbury Aug 7, 2024
2678299
Merge branch 'docs/pycafe_embedding' of https://github.com/mckinsey/v…
stichbury Aug 7, 2024
65b0a23
Update navigation.md
stichbury Aug 7, 2024
d8cd089
Update layouts.md
stichbury Aug 7, 2024
60908e3
Update themes.md
stichbury Aug 7, 2024
7c7f707
Update actions.md
stichbury Aug 7, 2024
a476769
Update custom-charts.md
stichbury Aug 7, 2024
a56f72d
Update custom-tables.md
stichbury Aug 7, 2024
6f74941
Update custom-components.md
stichbury Aug 7, 2024
2966fd6
Update custom-actions.md
stichbury Aug 7, 2024
73c63e6
Update custom-figures.md
stichbury Aug 7, 2024
a9218ab
Update explore-components.md
stichbury Aug 8, 2024
786167c
Add SVGs
stichbury Aug 12, 2024
d24a6f0
Update explore-components.md
stichbury Aug 12, 2024
64833f1
Updates to card button graphics and projects
stichbury Aug 12, 2024
ac90812
Convert links to HTML so open in new tab with image
stichbury Aug 12, 2024
13edb77
Update figure.md
stichbury Aug 12, 2024
f18199e
Add openpyxl as extra requirement
stichbury Aug 12, 2024
a719191
Revise locations of github-hosted graphics for py.cafe
stichbury Aug 12, 2024
ab9d720
Store graphics for carousel
stichbury Aug 12, 2024
5b97a3d
Update carousel example
stichbury Aug 12, 2024
740f855
Update assets.md
stichbury Aug 12, 2024
6b04506
Lint
stichbury Aug 12, 2024
6fdb521
Update data.md
stichbury Aug 12, 2024
5465692
Update data.md
stichbury Aug 12, 2024
5fb5368
Merge branch 'main' into docs/pycafe_embedding
stichbury Aug 12, 2024
935b58c
Update custom-figures.md
stichbury Aug 13, 2024
ff72918
Update page_sunburst.png
stichbury Aug 13, 2024
da1bd68
Update navigation.md
stichbury Aug 13, 2024
0d987c5
Merge branch 'main' into docs/pycafe_embedding
stichbury Aug 13, 2024
498f30f
Update custom-components.md
stichbury Aug 13, 2024
5ce3ecf
Merge branch 'docs/pycafe_embedding' of https://github.com/mckinsey/v…
stichbury Aug 13, 2024
1eee7bb
Delete pycafe_logo.png
stichbury Aug 14, 2024
3dfefe1
Update vizro-core/docs/pages/tutorials/explore-components.md
stichbury Aug 14, 2024
5de548d
Update vizro-core/docs/pages/tutorials/explore-components.md
stichbury Aug 14, 2024
7a69eb2
Example of using code block specifications with py.cafe plugin
maxschulz-COL Aug 14, 2024
e63e383
Update to image placement example
stichbury Aug 14, 2024
0657e6a
Merge branch 'docs/pycafe_embedding' of https://github.com/mckinsey/v…
stichbury Aug 14, 2024
40764c7
Update custom-components.md
stichbury Aug 14, 2024
a749572
Add simple footnotes to code as comments
stichbury Aug 14, 2024
7000a3e
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Aug 14, 2024
922455a
Update data.md
stichbury Aug 14, 2024
5ffa875
Update data.md
stichbury Aug 14, 2024
1acab8c
Merge branch 'docs/pycafe_embedding' of https://github.com/mckinsey/v…
stichbury Aug 14, 2024
a8e9bc6
Update vizro-core/docs/pages/user-guides/themes.md
stichbury Aug 14, 2024
e796c7c
Update vizro-core/docs/pages/user-guides/themes.md
stichbury Aug 14, 2024
757b7a7
Update hatch.toml
stichbury Aug 14, 2024
6fb44a8
Pull new change
maxschulz-COL Aug 14, 2024
7a8f05a
Update vizro-core/docs/pages/user-guides/card-button.md
stichbury Aug 14, 2024
a81215a
Update container.md
stichbury Aug 14, 2024
724320a
Merge branch 'docs/pycafe_embedding' of https://github.com/mckinsey/v…
stichbury Aug 14, 2024
f0e4c93
Update explore-components.md
stichbury Aug 14, 2024
3507614
Update vizro-core/hatch.toml
stichbury Aug 14, 2024
3df2956
Update profile for examples
stichbury Aug 15, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update container.md
stichbury committed Aug 14, 2024

Unverified

The committer email address is not verified.
commit a81215a1b914892d32e16e01a16134fc36a4ada3
8 changes: 5 additions & 3 deletions vizro-core/docs/pages/user-guides/container.md
Original file line number Diff line number Diff line change
@@ -55,11 +55,10 @@ To add a [`Container`][vizro.models.Container] to your page, do the following:

page = vm.Page(
title="Containers",
# Use layout default and stack the Containers vertically in one column
components=[
components=[ # (1)!
vm.Container(
title="Container I",
layout=vm.Layout(grid=[[0, 1]]), # Horizontally stack the components inside this Container
layout=vm.Layout(grid=[[0, 1]]), # (2)!
components=[
vm.Graph(
figure=px.scatter(
@@ -105,6 +104,9 @@ To add a [`Container`][vizro.models.Container] to your page, do the following:
Vizro().build(dashboard).run()
```

1. Note that the `Page.layout` argument is not specified here and will therefore defaults to `[[0], [1]]`, meaning the containers will be **vertically stacked** down the page in one column.
2. **Horizontally stack** the components side-by-side inside this `Container` in one row.

=== "app.yaml"
```yaml
# Still requires a .py to add data to the data manager and parse YAML configuration