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

Add tutorial section for documentation #6213

Merged
merged 252 commits into from
Feb 25, 2024
Merged
Show file tree
Hide file tree
Changes from 193 commits
Commits
Show all changes
252 commits
Select commit Hold shift + click to select a range
1f25c04
Convert tutorial notebooks to markdown
philippjfr Jan 16, 2024
809815c
Fix image links
philippjfr Jan 16, 2024
cba07e9
Update links
philippjfr Jan 16, 2024
9c6dae4
make change to enable refactor
MarcSkovMadsen Jan 16, 2024
d2ab6d1
change
MarcSkovMadsen Jan 16, 2024
f51521a
change
MarcSkovMadsen Jan 16, 2024
55bb1ae
Merge branch 'docs_fixes_1.4_a1_review' of https://github.com/holoviz…
MarcSkovMadsen Jan 16, 2024
304cb99
some improvement
MarcSkovMadsen Jan 17, 2024
c38885b
add panel serve section
MarcSkovMadsen Jan 17, 2024
4f6c602
merge with main
MarcSkovMadsen Jan 17, 2024
65ed786
add resource
MarcSkovMadsen Jan 17, 2024
86fba4f
apply feedback from review
MarcSkovMadsen Jan 18, 2024
366f58c
simplify
MarcSkovMadsen Jan 18, 2024
250e7c2
add develop_notebook guide
MarcSkovMadsen Jan 18, 2024
0aa2373
add shift tab
MarcSkovMadsen Jan 18, 2024
764447a
words
MarcSkovMadsen Jan 18, 2024
46cf2a1
make less scary
MarcSkovMadsen Jan 18, 2024
67dd6fb
add tutorial develop in editor
MarcSkovMadsen Jan 18, 2024
0687e12
make more precise
MarcSkovMadsen Jan 18, 2024
91e20de
refactor
MarcSkovMadsen Jan 18, 2024
ea3803a
Merge branch 'main' of https://github.com/holoviz/panel into docs_fix…
MarcSkovMadsen Jan 18, 2024
f68c7d0
add pn.panel tutorial
MarcSkovMadsen Jan 19, 2024
e657f51
add pn.panel tutorial
MarcSkovMadsen Jan 19, 2024
2c2adfa
review changes
MarcSkovMadsen Jan 19, 2024
6355e37
review updates
MarcSkovMadsen Jan 19, 2024
aff2586
add to index
MarcSkovMadsen Jan 19, 2024
211933b
Merge branch 'main' of https://github.com/holoviz/panel into docs_fix…
MarcSkovMadsen Jan 20, 2024
562bbd0
update
MarcSkovMadsen Jan 20, 2024
38a6ab0
fix links
MarcSkovMadsen Jan 20, 2024
bc0feca
add missing code
MarcSkovMadsen Jan 20, 2024
2c544d0
add panel serve notebook
MarcSkovMadsen Jan 20, 2024
60ec4b1
align editor and notebook tutorials
MarcSkovMadsen Jan 20, 2024
bb68edf
align
MarcSkovMadsen Jan 20, 2024
33c4e65
align
MarcSkovMadsen Jan 20, 2024
e5b037b
feedback from usage
MarcSkovMadsen Jan 20, 2024
a8aaa9e
simplify
MarcSkovMadsen Jan 20, 2024
e4955ef
feedback session
MarcSkovMadsen Jan 20, 2024
45d63de
review
MarcSkovMadsen Jan 20, 2024
756dc53
review
MarcSkovMadsen Jan 20, 2024
930ce49
align
MarcSkovMadsen Jan 20, 2024
64aac80
feedback from review
MarcSkovMadsen Jan 20, 2024
78b173c
update links
MarcSkovMadsen Jan 20, 2024
8b1f488
fix admonitions
MarcSkovMadsen Jan 20, 2024
2d57353
update the index
MarcSkovMadsen Jan 20, 2024
2f8ceee
refactor beginner-intermediate
MarcSkovMadsen Jan 20, 2024
3e149a2
refactor
MarcSkovMadsen Jan 20, 2024
e1bf7d0
minor refactor
MarcSkovMadsen Jan 20, 2024
25d483a
improve formulation
MarcSkovMadsen Jan 20, 2024
60d75e3
refactor components
MarcSkovMadsen Jan 20, 2024
60f10f7
rename to basic
Jan 21, 2024
99ec2e8
add Panes tutorial and improve a lot
Jan 21, 2024
ce30a69
simplify and add markdown reference
Jan 21, 2024
06d4b09
feedback from live docs
Jan 21, 2024
4f0c31c
refactorer datastore tutorial
Jan 21, 2024
84de9cb
refactor
Jan 21, 2024
cb986ac
refactor
Jan 21, 2024
03531d6
move develop tutorial
Jan 21, 2024
ad92cd9
minor adjustments
Jan 21, 2024
5d67281
code review
Jan 22, 2024
b6d2d2a
add layout guide
Jan 22, 2024
4c0011f
review and fix
Jan 22, 2024
7100b6f
fix
Jan 22, 2024
a928def
pre-commit
MarcSkovMadsen Jan 22, 2024
68c9460
refactor
Jan 23, 2024
f0375f1
wip
Jan 23, 2024
0b50027
remove outline
Jan 23, 2024
1a30b12
add widgets
Jan 23, 2024
7873ae2
review
Jan 23, 2024
13480d2
Merge branch 'docs_fixes_1.4_a1_review' of https://github.com/holoviz…
Jan 23, 2024
b0e45a4
add chat input tutorial
Jan 23, 2024
09aee32
update
Jan 23, 2024
065af34
small fixes
Jan 23, 2024
081fa1b
implement review feedback
Jan 24, 2024
a817f58
feedback from review
Jan 24, 2024
e394b75
update chat bot
Jan 24, 2024
4799cc3
implement feedback
Jan 24, 2024
8139517
add parts of wind turbine report
Jan 24, 2024
36e725d
small improvements
Jan 24, 2024
54d119e
update resource list
Jan 24, 2024
6daf821
review feedback
Jan 24, 2024
ec48f09
update
Jan 26, 2024
93f277f
fix
Jan 26, 2024
b461c58
add image classifier
Jan 27, 2024
06a7df9
fix
Jan 27, 2024
bb5cb7c
change width/ height
Jan 27, 2024
31d4a58
wip
Jan 27, 2024
cd5079c
reorganize
Jan 28, 2024
547f1ae
update
Jan 28, 2024
28e3d7c
move outline here
Jan 28, 2024
823d3ba
add explore data set
Jan 28, 2024
64218b7
simplify
Jan 28, 2024
c00094d
add streaming dashboard example
Jan 28, 2024
543969b
add build dashboard
Jan 28, 2024
63164eb
Update doc/explanation/develop_seamlessly.md
MarcSkovMadsen Jan 29, 2024
9361093
Update doc/explanation/develop_seamlessly.md
MarcSkovMadsen Jan 29, 2024
0af4a98
Update doc/explanation/develop_seamlessly.md
MarcSkovMadsen Jan 29, 2024
e8ca133
Update doc/explanation/develop_seamlessly.md
MarcSkovMadsen Jan 29, 2024
d30f226
Update doc/tutorials/basic/build_chatbot.md
MarcSkovMadsen Jan 29, 2024
ad310d2
simplify
Jan 29, 2024
a62506b
Update doc/tutorials/basic/build_chatbot.md
MarcSkovMadsen Jan 29, 2024
438e574
Update doc/tutorials/basic/build_chatbot.md
MarcSkovMadsen Jan 29, 2024
141454d
Update doc/tutorials/basic/build_chatbot.md
MarcSkovMadsen Jan 29, 2024
7853225
Update doc/tutorials/basic/build_chatbot.md
MarcSkovMadsen Jan 29, 2024
9332896
simplify
Jan 29, 2024
66cc6fc
improve
Jan 29, 2024
88e3311
minor fixes
Jan 29, 2024
3081ed0
add templates
MarcSkovMadsen Jan 29, 2024
366af61
Merge origin/main
philippjfr Jan 29, 2024
5ac804c
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 29, 2024
b728717
Fix spelling
philippjfr Jan 29, 2024
ecf7d2c
Optimize PNG images (lossless)
philippjfr Jan 29, 2024
f5b86a6
explain the templates
Jan 30, 2024
815d906
finalize templates
Jan 30, 2024
b3cc601
improve join community
Jan 30, 2024
5466059
Merge branch 'docs_fixes_1.4_a1_review' of https://github.com/holoviz…
Jan 30, 2024
bb16d1d
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 30, 2024
47cc7fd
Optimize PNG images (lossless)
pre-commit-ci[bot] Jan 30, 2024
cbe7c4a
add installation
Jan 30, 2024
9eb984c
add plot and table events
Jan 30, 2024
84d98e6
Begin review and fix up admonitions
philippjfr Jan 30, 2024
16dbdde
Review display section
philippjfr Jan 30, 2024
f5becbc
Review Organize content sections
philippjfr Jan 30, 2024
a275639
use we more
MarcSkovMadsen Jan 31, 2024
504da32
move table and plot events
MarcSkovMadsen Feb 1, 2024
6633e16
restructure
MarcSkovMadsen Feb 1, 2024
d4b30d6
add monitoring dashboard
MarcSkovMadsen Feb 1, 2024
6cc48b0
monitoring dashboard image
MarcSkovMadsen Feb 1, 2024
bc065d1
Optimize PNG images (lossless)
MarcSkovMadsen Feb 1, 2024
cccb576
add indicators tutorial
MarcSkovMadsen Feb 1, 2024
4b4c7b6
change to wind turbine narrative
MarcSkovMadsen Feb 1, 2024
6ec4dbd
Merge branch 'docs_fixes_1.4_a1_review' of https://github.com/holoviz…
MarcSkovMadsen Feb 1, 2024
6f5e404
Optimize PNG images (lossless)
MarcSkovMadsen Feb 1, 2024
cd4cc7c
bar chart race
MarcSkovMadsen Feb 2, 2024
8b33f62
Merge branch 'docs_fixes_1.4_a1_review' of https://github.com/holoviz…
MarcSkovMadsen Feb 2, 2024
d10d4a2
simplify
MarcSkovMadsen Feb 2, 2024
8df0ec4
simplify
MarcSkovMadsen Feb 2, 2024
7a6a036
make responsive
MarcSkovMadsen Feb 2, 2024
1024cdb
align plot examples. Add altair example
MarcSkovMadsen Feb 2, 2024
a830f55
align panel and panes
MarcSkovMadsen Feb 2, 2024
731c77a
convert to wind example
MarcSkovMadsen Feb 2, 2024
b5a8921
clean up
MarcSkovMadsen Feb 2, 2024
cc3be52
size
MarcSkovMadsen Feb 3, 2024
e97d047
Optimize PNG images (lossless)
MarcSkovMadsen Feb 3, 2024
5306ec6
update size tutorial and admonitions
MarcSkovMadsen Feb 3, 2024
d784d90
Merge branch 'docs_fixes_1.4_a1_review' of https://github.com/holoviz…
MarcSkovMadsen Feb 3, 2024
3fc46c6
try organising in tabs
MarcSkovMadsen Feb 3, 2024
0288e69
improve
MarcSkovMadsen Feb 3, 2024
1ebedd6
simplify
MarcSkovMadsen Feb 3, 2024
9dd49e9
Update doc/tutorials/basic/panes.md
MarcSkovMadsen Feb 3, 2024
938d5d1
fix
MarcSkovMadsen Feb 3, 2024
829e3ad
Merge branch 'docs_fixes_1.4_a1_review' of https://github.com/holoviz…
MarcSkovMadsen Feb 3, 2024
a0966b6
align serve
MarcSkovMadsen Feb 3, 2024
878ce0f
Optimize PNG images (lossless)
MarcSkovMadsen Feb 3, 2024
4c6e449
add style and design
MarcSkovMadsen Feb 3, 2024
6ffadc8
Merge branch 'docs_fixes_1.4_a1_review' of https://github.com/holoviz…
MarcSkovMadsen Feb 3, 2024
5535978
review feedback and fix of section links
MarcSkovMadsen Feb 4, 2024
86d96e0
define target audience
MarcSkovMadsen Feb 4, 2024
8dde4ae
add align tutorial
MarcSkovMadsen Feb 4, 2024
1318347
Optimize PNG images (lossless)
MarcSkovMadsen Feb 4, 2024
4572b2f
add progressive layouts
MarcSkovMadsen Feb 4, 2024
dceeed0
fix reactive expressions
MarcSkovMadsen Feb 4, 2024
21d3727
fix issues
MarcSkovMadsen Feb 4, 2024
0bc77e8
add activity indicators
MarcSkovMadsen Feb 5, 2024
20cc223
Optimize PNG images (lossless)
MarcSkovMadsen Feb 5, 2024
fa9e75b
add caching tutorial
MarcSkovMadsen Feb 5, 2024
5c14217
Optimize PNG images (lossless)
MarcSkovMadsen Feb 5, 2024
c1bd855
minor fixes
MarcSkovMadsen Feb 5, 2024
ff1bdb7
Merge branch 'docs_fixes_1.4_a1_review' of https://github.com/holoviz…
MarcSkovMadsen Feb 5, 2024
db46d7f
finalize streaming dashboard
MarcSkovMadsen Feb 5, 2024
09b9898
fix
MarcSkovMadsen Feb 5, 2024
90730f4
Merge branch 'main' of https://github.com/holoviz/panel into docs_fix…
MarcSkovMadsen Feb 6, 2024
d0e0883
reorganise the tutorial
MarcSkovMadsen Feb 6, 2024
d4d0bb4
fix issues
MarcSkovMadsen Feb 7, 2024
6a8a15f
fix issues
MarcSkovMadsen Feb 7, 2024
f16cc78
improve caching tutorial
MarcSkovMadsen Feb 8, 2024
defd791
improve panel and panes
MarcSkovMadsen Feb 8, 2024
075ce17
fix
MarcSkovMadsen Feb 8, 2024
8f689f9
build a dashboard
MarcSkovMadsen Feb 8, 2024
a046b28
fix
MarcSkovMadsen Feb 8, 2024
dd75d63
add deployment
MarcSkovMadsen Feb 9, 2024
634da8e
Optimize PNG images (lossless)
MarcSkovMadsen Feb 9, 2024
dcc48d2
change to Panel account
MarcSkovMadsen Feb 9, 2024
fc01afb
Merge branch 'docs_fixes_1.4_a1_review' of https://github.com/holoviz…
MarcSkovMadsen Feb 9, 2024
4ac075c
Optimize PNG images (lossless)
MarcSkovMadsen Feb 9, 2024
bc8d02e
commit changes
MarcSkovMadsen Feb 9, 2024
6fafbc6
add more orgs
MarcSkovMadsen Feb 9, 2024
9f0a023
add badge
MarcSkovMadsen Feb 9, 2024
add52fa
Merge branch 'main' of https://github.com/holoviz/panel into docs_fix…
MarcSkovMadsen Feb 9, 2024
1fb2579
fix
MarcSkovMadsen Feb 9, 2024
475f0e2
clean up
MarcSkovMadsen Feb 9, 2024
0e9965b
review
MarcSkovMadsen Feb 10, 2024
dc11e03
maxime feedback
MarcSkovMadsen Feb 18, 2024
3c42ebc
fix test failure
MarcSkovMadsen Feb 18, 2024
8b85b33
minor fix
MarcSkovMadsen Feb 18, 2024
e54b4ff
Merge branch 'main' of https://github.com/holoviz/panel into docs_fix…
MarcSkovMadsen Feb 18, 2024
fa8d1be
refactor explore data
MarcSkovMadsen Feb 18, 2024
ca5b174
move join community to community page
MarcSkovMadsen Feb 18, 2024
ab3545b
remove reference to topics
MarcSkovMadsen Feb 19, 2024
97fe1a3
use bokeh 3.3.0
MarcSkovMadsen Feb 19, 2024
244faff
maxime feedback
MarcSkovMadsen Feb 19, 2024
c46dfaa
Optimize PNG images (lossless)
MarcSkovMadsen Feb 19, 2024
cf341ee
update monitoring dashboard example
MarcSkovMadsen Feb 20, 2024
b1c9bb9
minor updates
MarcSkovMadsen Feb 21, 2024
a25ccfb
add explanations
MarcSkovMadsen Feb 21, 2024
f6665a9
explain animation
MarcSkovMadsen Feb 21, 2024
e9d0e17
pip first
MarcSkovMadsen Feb 21, 2024
37f1683
revert bokeh version to 3.4 dev
MarcSkovMadsen Feb 21, 2024
c245abd
Merge branch 'main' of https://github.com/holoviz/panel into docs_fix…
MarcSkovMadsen Feb 21, 2024
5638003
add usage section
MarcSkovMadsen Feb 21, 2024
478667a
update todo app
MarcSkovMadsen Feb 21, 2024
51ccbb2
minor fixes
MarcSkovMadsen Feb 21, 2024
26ca4b7
improve language
MarcSkovMadsen Feb 22, 2024
1afb170
improve language
MarcSkovMadsen Feb 22, 2024
c42ab0e
improve language
MarcSkovMadsen Feb 22, 2024
7459ac8
improve language
MarcSkovMadsen Feb 22, 2024
89a4c32
improve language
MarcSkovMadsen Feb 22, 2024
9115f10
Optimize PNG images (lossless)
MarcSkovMadsen Feb 22, 2024
d386a95
fix build
MarcSkovMadsen Feb 23, 2024
5a48407
improve language
MarcSkovMadsen Feb 23, 2024
a257627
improve language
MarcSkovMadsen Feb 23, 2024
018563b
improve language
MarcSkovMadsen Feb 23, 2024
64c213e
fix tabset
MarcSkovMadsen Feb 23, 2024
2bd1f5e
improve language
MarcSkovMadsen Feb 23, 2024
0770c9c
improve language
MarcSkovMadsen Feb 23, 2024
0347401
improve language
MarcSkovMadsen Feb 23, 2024
1622aa7
improve language
MarcSkovMadsen Feb 23, 2024
e0c82ce
improve language
MarcSkovMadsen Feb 23, 2024
add5754
improve language
MarcSkovMadsen Feb 23, 2024
ce703ed
Optimize PNG images (lossless)
MarcSkovMadsen Feb 23, 2024
7cdd477
Merge branch 'main' of https://github.com/holoviz/panel into docs_fix…
MarcSkovMadsen Feb 23, 2024
51c890e
update front page as agreed
MarcSkovMadsen Feb 23, 2024
950060d
improve formulation
MarcSkovMadsen Feb 24, 2024
2d5338c
make less overwhelming
MarcSkovMadsen Feb 24, 2024
a2d99de
improve language
MarcSkovMadsen Feb 24, 2024
d6dfdb4
refactor install instruction
MarcSkovMadsen Feb 24, 2024
5088547
reorder
MarcSkovMadsen Feb 24, 2024
93ccaa8
improve
MarcSkovMadsen Feb 24, 2024
9196270
make less overwhelming
MarcSkovMadsen Feb 24, 2024
d2c6fdb
refactor intermediate tutorial
MarcSkovMadsen Feb 24, 2024
9c6fa56
Make tutorial descriptions ready for release
MarcSkovMadsen Feb 24, 2024
0968f88
fix issue
MarcSkovMadsen Feb 24, 2024
8adeb93
improve getting started
MarcSkovMadsen Feb 25, 2024
aa8e4a2
Improve build an app. Align getting started icons
MarcSkovMadsen Feb 25, 2024
a2bf270
improve getting started
MarcSkovMadsen Feb 25, 2024
ddc4485
move community page
MarcSkovMadsen Feb 25, 2024
bd45ce6
Optimize PNG images (lossless)
MarcSkovMadsen Feb 25, 2024
06fb410
update outliers_declarative
MarcSkovMadsen Feb 25, 2024
4eaf8d3
Merge branch 'docs_fixes_1.4_a1_review' of https://github.com/holoviz…
MarcSkovMadsen Feb 25, 2024
c0444eb
revert change
MarcSkovMadsen Feb 25, 2024
a2d5437
Merge branch 'main' of https://github.com/holoviz/panel into docs_fix…
MarcSkovMadsen Feb 25, 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
4 changes: 4 additions & 0 deletions doc/_static/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,7 @@ button.copybtn:hover {
.o-tooltip--left:after {
background: none;
}

video {
max-width: 100%;
}
Binary file added doc/_static/images/align-cards-solution.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/images/awesome-panel.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/images/develop_editor_breakpoint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/images/develop_editor_click_me.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/images/develop_editor_hover.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/images/develop_editor_layout0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/images/develop_editor_layout1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/images/develop_editor_param.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/images/develop_editor_serve_app.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed doc/_static/images/editor_server_app.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/images/hugging_face_spaces_delete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/images/hugging_face_spaces_files.png
Binary file added doc/_static/images/hugging_face_spaces_panel.png
Binary file added doc/_static/images/indicators_section.png
Binary file added doc/_static/images/join_community_discord.png
Binary file added doc/_static/images/join_community_discourse.png
Binary file added doc/_static/images/join_community_github.png
Binary file added doc/_static/images/join_community_linkedin.png
Binary file added doc/_static/images/join_community_open_source.png
Binary file added doc/_static/images/join_community_twitter.png
Binary file added doc/_static/images/layouts_section.png
Binary file added doc/_static/images/monitoring_dashboard.png
Binary file added doc/_static/images/notebook_inspect_print.png
Binary file added doc/_static/images/notebook_inspect_print_1.png
Binary file added doc/_static/images/notebook_inspect_shift_tab.png
Binary file added doc/_static/images/panel-chat-examples.png
Binary file added doc/_static/images/panel-serve-ipynb-app.png
Binary file added doc/_static/images/panel-serve-ipynb-notebook.png
Binary file added doc/_static/images/panel-serve-multipage-app.png
Binary file added doc/_static/images/panel-serve-py-app.png
Binary file added doc/_static/images/panes.png
Binary file added doc/_static/images/panes_markdown_reference.png
Binary file added doc/_static/images/structure_data_store_app.png
Binary file added doc/_static/images/templates_customized_dark.png
Binary file added doc/_static/images/templates_hello_world.png
Binary file added doc/_static/images/templates_section.png
Binary file added doc/_static/images/understand_load.png
Binary file added doc/_static/images/understand_load_refresh.png
Binary file removed doc/_static/images/vscode-script.png
Diff not rendered.
Binary file added doc/_static/images/widgets_button_reference.png
415 changes: 311 additions & 104 deletions doc/explanation/components/components_overview.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -1,19 +1,17 @@
# Effective Development
# Develop Seamlessly Across Environments

:::{note} Tutorial 4. **Efficient Development**
:icon: false
Our objective is to empower teams to seamlessly utilize Panel regardless of the development environment, e.g. Jupyter Notebook, Jupyter Lab, Binder, Google Colab, Spyder, VS Code, and PyCharm.

It's also important for you to be able to use a coding environment you are comfortable with. To this end, Panel offers very good support for Jupyter Notebooks (Classic and JupyterLab) and editors like Visual Studio Code, which are the two environments we will cover in this guide.

:::

## Notebook

We love notebooks.

### Notebook friendly

Jupyter notebooks have been supported in Panel since day 1 and more generally since the inception of the HoloViz project. Notebooks are environments that allow to iterate quickly, running some code and observing instantaneously its output. Notebooks also happen to be a valid deployment option:
Jupyter notebooks have been supported in Panel since day 1. Notebooks are environments that allow one to iterate quickly, running some code and observing instantaneously its output. Notebooks also happen to be a valid deployment option:

- you can actually develop apps that are meant to live only in a notebook, that you will share as a file with your colleagues and friends. Panel allows you to make your notebooks more user friendly, like IPywidgets does.
- you can actually develop apps that are meant to live only in a notebook, that you will share as a file with your colleagues and friends. Panel allows you to make your notebooks more user friendly, like [IPywidgets](https://ipywidgets.readthedocs.io/en/stable/) does.
- you can serve a notebook with `panel serve file.ipynb`, Panel will parse your notebook to collect all of its code and run it as if it were a Python script.

Jupyter notebooks aren't the only flavor of notebooks available, Panel also supports Visual Studio Code and Google Colab notebooks, and probably works fine on other platforms. For Visual Studio Code notebooks, you will need to install the `jupyter_bokeh` package in your environment.
Expand All @@ -28,7 +26,7 @@ import panel as pn
pn.extension()
```

The extension ensures that all required Javascript and CSS resources are added to your notebook environment. If you are going to be using any custom extensions, such as [Vega](../reference/panes/Vega.md) or [Tabulator](../reference/widgets/Tabulator.md) you must ensure that you initialize these as well.
The extension ensures that the [`pyviz_comms`](https://github.com/holoviz/pyviz_comms) and all required Javascript and CSS resources are added to your notebook environment. If you are going to be using any custom extensions, such as [Vega](../reference/panes/Vega.md) or [Tabulator](../reference/widgets/Tabulator.md) you must ensure that you initialize these as well.

```{pyodide}
pn.extension('vega', 'tabulator')
Expand Down Expand Up @@ -69,7 +67,7 @@ pn.Row(w, pn.bind(compute, w))

### Render templates

You have been told in the previous guide to avoid rendering Panel templates in a notebook. That's however not a dead end! There are two approaches you can leverage to display an app that is wrapped in a template while working from a notebook, in addition to just being able to serve the notebook with `panel serve notebook.ipynb`.
You have been told in the Panel tutorial to avoid rendering Panel templates in a notebook. That's however not a dead end! There are two approaches you can leverage to display an app that is wrapped in a template while working from a notebook, in addition to just being able to serve the notebook with `panel serve notebook.ipynb`.

Templates, as any other Panel visual components, are equipped with the `.show()` method that when called starts a Bokeh server, serves your app and opens it in a new tab. While this approach doesn't allow you to iterate super quickly, it's a simple way to check what your app looks like when served.

Expand Down Expand Up @@ -116,11 +114,13 @@ This is what you should be able to see after a little while. Now tick `Render on

![alt text](../_static/images/jlabpreview.png)

## Visual Studio Code
## Editor

Editors like VS Code and PyCharm have quickly become some of the most popular Python coding environment.

Visual Studio Code (VS Code) has quickly become one of the most popular Python coding environment. In this section you will see how you can to set yourself a nice developer experience with VS Code when developing a Panel app.
### Serve apps with autoreload

### Setup and autoreload
To enable a quick feedback loop while developing, we support serving your apps with autoreload.

Save the content of the next cell in a file named `app.py`.

Expand Down Expand Up @@ -153,35 +153,15 @@ The `--show` flag will open a browser tab with the live app and the `--autoreloa

![VSCode Preview](../_static/images/vscode_preview.png)

### Debugging

While you can debug your app using the often blamed but never outperformed `print`, or by manually adding breakpoints with `breakpoint()`, the VS Code integrated debugger offers a more user friendly experience.

To configure the integrated debugger for Panel, you will need to add a debugging configuration like the following.

```json
// .vscode/launch.json
{
"version": "0.2.0",
"configurations": [
{
"name": "panel serve",
"type": "python",
"request": "launch",
"program": "-m",
"args": [
"panel",
"serve",
"${relativeFile}",
"--show"
],
"console": "integratedTerminal",
"justMyCode": true
}
]
}
```
## Resources

### Tutorials

- [Develop in an Editor (Basic)](../tutorials/basic/develop_editor.md)
- [Develop in an Editor (Intermediate)](../tutorials/intermediate/develop_editor.md)¨
- [Develop in a Notebook (Basic)](../tutorials/basic/develop_notebook.md)

With this configuration in place, launching the debugger will serve the file you are working on with Panel, open a new browser tab pointing at the served app. Interact then with your app to hit one of the breakpoints you set up in VS Code.
### How-to

![VSCode Debugging](../static/images/vscode_debug.png)
- [Configure VS Code](../how_to/editor/vscode_configure.md)
- [Write apps in Markdown](../how_to/editor/markdown.md)
14 changes: 14 additions & 0 deletions doc/explanation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,20 @@ The explanation section aims to clarify, deepen, and broaden the understanding o

Beyond the [Getting Started > Core Concepts](../getting_started/core_concepts.md), which new users must complete before working with Panel, this explanation section is intended to help practitioners form and strengthen a conceptual web that facilitates new and advanced usage directions.

## Develop

::::{grid} 1 2 2 3
:gutter: 1 1 1 2

:::{grid-item-card} {octicon}`code;2.5em;sd-mr-1 sd-animate-grow50` Develop Seamlessly
:link: api/index
:link-type: doc

Learn how we enable you and your team to work seamlessly with Panel across a wide range of development environments
:::

::::

## APIs

::::{grid} 1 2 2 3
Expand Down
6 changes: 4 additions & 2 deletions doc/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

MarcSkovMadsen marked this conversation as resolved.
Show resolved Hide resolved
Welcome to Panel!

The getting started guide will get you set up with Panel and provide a basic overview of the features and strengths of Panel.
The getting started guides are for those who would like to **quickly try out Panel** and **explore the features and strengths of Panel**.

---

Expand Down Expand Up @@ -33,14 +33,16 @@ Before we dig into some of the core concepts behind Panel this guide gives you a
:link: core_concepts
:link-type: doc

Introduces you to some of the core concepts behind Panel, how to develop Panel applications effectively both in your IDE and in the notebook and some of the core features that make Panel such a powerful library.
Introduces you to some of the core concepts behind Panel, how to develop Panel applications effectively both in your Editor and in the notebook and some of the core features that make Panel such a powerful library.

+++
[Learn more »](core_concepts)
:::

::::

As the next step after this Getting Started guide, we recommend learning the basics of Panel systematically via the *in depth* [Basic Tutorials](../tutorials/basic/index.md).

## Additional Resources

- The [original announcement of Panel from 2019](https://blog.holoviz.org/panel_announcement.html).
Expand Down
2 changes: 1 addition & 1 deletion doc/how_to/authentication/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ panel serve app.py --basic-auth credentials.json --cookie-secret my_super_safe_c

The basic auth provider will now check the provided credentials against the credentials declared in this file.

:::note
:::{admonition} Note
When serving an application dynamically using `pn.serve` you can also provide a dictionary of usernames and passwords via the `basic_auth` keyword argument.
:::

Expand Down
2 changes: 1 addition & 1 deletion doc/how_to/components/construct_panes.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This guide addresses how to construct Pane objects for displaying visible compon

There are two main ways to construct a pane - explicitly or automatically.

To explicitly construct a pane, use one of the pane types listed in the [component gallery](../../reference/index.md#panes). For example, you can create a Markdown pane as follows:
To explicitly construct a pane, use one of the pane types listed in the [component gallery](https://panel.holoviz.org/reference/index.md#panes). For example, you can create a Markdown pane as follows:

```{pyodide}
import panel as pn
Expand Down
46 changes: 0 additions & 46 deletions doc/how_to/editor/editor.md

This file was deleted.

16 changes: 0 additions & 16 deletions doc/how_to/editor/editor_debug.md

This file was deleted.

16 changes: 1 addition & 15 deletions doc/how_to/editor/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,6 @@ One of the main design goals for Panel was to make it seamless to work across de
::::{grid} 1 2 2 3
:gutter: 1 1 1 2

:::{grid-item-card} {octicon}`code-square;2.5em;sd-mr-1 sd-animate-grow50` Develop apps in an editor
:link: editor
:link-type: doc

How to rapidly develop a Panel application in your favorite IDE or editor.
:::

:::{grid-item-card} {octicon}`bug;2.5em;sd-mr-1 sd-animate-grow50` Debug apps in an editor
:link: editor_debug
:link-type: doc

How to debug a Panel application in your favorite IDE or editor.
:::

:::{grid-item-card} {octicon}`gear;2.5em;sd-mr-1 sd-animate-grow50` Configure VS Code
:link: vscode_configure
:link-type: doc
Expand All @@ -40,6 +26,6 @@ How to write Panel applications inside Markdown files.
:hidden:
:maxdepth: 2

editor
vscode_configure
markdown
```
2 changes: 1 addition & 1 deletion doc/how_to/editor/vscode_configure.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This guide addresses how to configure VS Code for an efficient Panel development

We assume you have

- a basic understanding of [developing Panel apps in an editor](editor.md) and [working with Python in VS Code](https://code.visualstudio.com/docs/python/python-tutorial).
- a basic understanding of [working with Python in VS Code](https://code.visualstudio.com/docs/python/python-tutorial).
- installed the VS Code [Python extension](https://github.com/Microsoft/vscode-python)

---
Expand Down
2 changes: 1 addition & 1 deletion doc/how_to/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
The Panel How-to guides provide step by step recipes for solving essential problems and tasks that arise during your work. They assume that you've completed the Getting Started material and therefore already have some knowledge of how Panel works. There is no order to the guides, other than any potential prerequisites listed at the top of a page. Jump to the topic that is relevant to you now.


## Prepare to develop
## Develop Efficiently

::::{grid} 1 2 2 3
:gutter: 1 1 1 2
Expand Down
2 changes: 1 addition & 1 deletion doc/how_to/notebook/jupyterlabpreview.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The *Preview* offers two update modes that are configurable in the preview tab:
- automatic: toggle the *Render on save* checkbox ({far}`square-check`) for the app to be automatically re-rendered when you save your notebook.

:::{tip}
Panel [built-in templates](../../reference/index.md#templates) don't render necessarily well in a notebook as their styling can badly interact with the notebook built-in styling. Using the *Preview* is a good way to circumvent this issue, while still being able to work within JupyterLab .
Panel [built-in templates](https://panel.holoviz.org/reference/index.md#templates) don't render necessarily well in a notebook as their styling can badly interact with the notebook built-in styling. Using the *Preview* is a good way to circumvent this issue, while still being able to work within JupyterLab .
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I haven't followed along in the PR, but this will not work on the dev website.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The problem is that the existing link did not work/ display. For some reason its really, really hard to link to internal sections (#templates) in the documentation.

I know it won't link to dev docs. But I've not been able to find any other solution. And I've tried a lot.

:::

## Related Resources
4 changes: 2 additions & 2 deletions doc/how_to/server/commandline.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Launching a server on the commandline
# Launch a server on the commandline

Once the app is ready for deployment it can be served using the Bokeh server. For a detailed breakdown of the design and functionality of Bokeh server, see the [Bokeh documentation](https://bokeh.pydata.org/en/latest/docs/user_guide/server.html). The most important thing to know is that Panel (and Bokeh) provide a CLI command to serve a Python script, app directory, or Jupyter notebook containing a Bokeh or Panel app. To launch a server using the CLI, simply run:

Expand All @@ -20,7 +20,7 @@ We recommend installing `watchfiles`, which will provide a significantly better

The ``panel serve`` command has the following options:

``` console
```bash
positional arguments:
DIRECTORY-OR-SCRIPT The app directories or scripts to serve (serve empty document if not specified)

Expand Down
2 changes: 1 addition & 1 deletion doc/how_to/streamlit_migration/caching.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ In Panel
- your script is run once when a user visits the page.
- only *specific, bound functions* are rerun on user interactions.

Thus with Panel you *may use* caching to to make the user experience nice and fast.
Thus with Panel you *may use* caching to make the user experience nice and fast.

In Panel you use `pn.cache` to speed up your apps. Check out the [Cache How-To Guides](../caching/index.md) for more details.

Expand Down
4 changes: 2 additions & 2 deletions doc/how_to/streamlit_migration/get_started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Get Started migrating from Streamlit to Panel
# Serve Apps

This guide addresses the basics of migrating from Streamlit to Panel.
This guide will show you how-to migrate and serve a *Hello World* application.

---

Expand Down
6 changes: 3 additions & 3 deletions doc/how_to/streamlit_migration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ These guides can also be used as:
::::{grid} 1 2 2 3
:gutter: 1 1 1 2

:::{grid-item-card} {octicon}`rocket;2.5em;sd-mr-1 sd-animate-grow50` Get Started
:::{grid-item-card} {octicon}`rocket;2.5em;sd-mr-1 sd-animate-grow50` Serve Apps
:link: get_started
:link-type: doc

How to convert a Hello World application from Streamlit to Panel
How to convert a *Hello World* application from Streamlit to Panel and serve it
:::

:::{grid-item-card} {octicon}`device-desktop;2.5em;sd-mr-1 sd-animate-grow50` Display Content
:::{grid-item-card} {octicon}`device-desktop;2.5em;sd-mr-1 sd-animate-grow50` Display Objects
:link: panes
:link-type: doc

Expand Down
2 changes: 1 addition & 1 deletion doc/how_to/streamlit_migration/interactivity.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ data = np.random.normal(1, 1, size=100)
bins_input = pn.widgets.IntSlider(value=20, start=10, end=30, step=1, name="Bins")
bplot = pn.bind(plot, data=data, bins=bins_input)

pn.Column(bins, bplot).servable()
pn.Column(bins_input, bplot).servable()
```

![Panel Basic Interactivity Example](https://assets.holoviz.org/panel/gifs/panel_interactivity_example.gif)
Expand Down
4 changes: 2 additions & 2 deletions doc/how_to/streamlit_migration/layouts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Organize Components with Layouts
# Layout Objects

*Layouts* helps you organize your Panel *components*, i.e. *panes*, *widgets* and *layouts*.
*Layouts* helps you organize your *objects* including Panel *components*.

Panel provides layouts similar to the ones you know from Streamlit and many unique ones too.

Expand Down
2 changes: 1 addition & 1 deletion doc/how_to/streamlit_migration/panes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Displaying Content with Panes
# Display Objects with Panes

In Panel the objects that can display your Python objects are called *panes*. With Panels *panes* you will be able to:

Expand Down
2 changes: 1 addition & 1 deletion doc/how_to/styling/design.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ def create_components(design):
pn.widgets.FloatSlider(name='Slider', design=design),
pn.widgets.TextInput(name='TextInput', design=design),
pn.widgets.Select(
name='Select', options=['Biology', 'Chemistry', 'Physics'], design=design
name='Select', options=['Biology', 'Chemistry', 'Physics'], design=design
),
pn.widgets.Button(
name='Click me!', icon='hand-click', button_type='primary', design=design
Expand Down
Loading
Loading