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.

Sign up for GitHub

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

Jump to bottom

docs: Split interactive docs section into subpages #3561

Merged
merged 12 commits into from
Aug 31, 2024
Merged

docs: Split interactive docs section into subpages #3561

merged 12 commits into from
Aug 31, 2024

Conversation

joelostblom
Copy link
Contributor

@joelostblom joelostblom commented Aug 27, 2024 •
edited
Loading

As discussed in #3500 with @dangotbanned

New look:
image

@joelostblom
Split interactivity doc section into subpages
4bbce76 
To make it easier to navigate instead of having one giant page.
@joelostblom
Move JupyterChart under main interactivity section
a8769a0 
The parts about performance and JupyterChart
are under the Large Datasets section,
so it seems natural that the part about interactivity
would go together with the other interactive parts
of the library.
@joelostblom
Note that streamlit can access params from python
a7c95e3
@joelostblom
Standardize use of ampersand in headings
7f5db72
@joelostblom
Remove dashboard sentence from JupyterChart page
6a9b38b
@joelostblom
Add heading to interaction landing page
7d8367e 
I think this looks more pleasing
as content without a right-side ToC
stretches wider across the page.
@dangotbanned
Copy link
Member

FYI I was about to try building the docs, but needed this merged #3560

vl_convert stubs untracked

image

@dangotbanned
Copy link
Member

45ffa94 (#3561) fixed those pages not diplaying any charts.

sphinx shouting at me 
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\bindings_widgets.rst:45 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\bindings_widgets.rst:80 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\bindings_widgets.rst:120 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\bindings_widgets.rst:169 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\bindings_widgets.rst:202 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\bindings_widgets.rst:253 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\bindings_widgets.rst:276 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\bindings_widgets.rst:305 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\bindings_widgets.rst:323 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\bindings_widgets.rst:339 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\bindings_widgets.rst:373 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\expressions.rst:22 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\expressions.rst:55 Code Execution failed:NameError: name 'chart' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\expressions.rst:64 Code Execution failed:NameError: name 'chart' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\expressions.rst:70 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\expressions.rst:94 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\expressions.rst:117 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)
C:\Users\danie\AppData\Local\hatch\env\virtual\altair\CXM7NV9I\doc\Lib\site-packages\sphinxext_altair\altairplot.py:261: UserWarning: altair-plot: C:\Users\danie\Documents\GitHub\altair\doc\user_guide\interactions\expressions.rst:149 Code Execution failed:NameError: name 'alt' is not defined
  warnings.warn(message, stacklevel=1)

dangotbanned
dangotbanned requested changes Aug 31, 2024
View reviewed changes
Copy link
Member

@dangotbanned dangotbanned left a comment

Choose a reason for hiding this comment

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

Overall this makes for a much easier read thanks @joelostblom!

I was already on-board with the idea, so probably best to have approval from another maintainer.
index.rst is the only page I think needs revisiting, feel free to dismiss the suggestions

doc/user_guide/interactions/index.rst Outdated Show resolved Hide resolved
doc/user_guide/interactions/parameters.rst Outdated Show resolved Hide resolved
doc/user_guide/interactions/parameters.rst Outdated Show resolved Hide resolved
doc/user_guide/interactions/parameters.rst Outdated Show resolved Hide resolved
doc/user_guide/interactions/parameters.rst Outdated Show resolved Hide resolved
doc/user_guide/interactions/parameters.rst Outdated Show resolved Hide resolved
@dangotbanned dangotbanned mentioned this pull request Aug 31, 2024
Closed
binste
binste approved these changes Aug 31, 2024
View reviewed changes
Copy link
Contributor

@binste binste left a comment

Choose a reason for hiding this comment

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

I haven't read through all changes but I'm also all onboard splitting the interactive docs! Looks much better :) Thanks!

dangotbanned
dangotbanned approved these changes Aug 31, 2024
View reviewed changes
Copy link
Member

@dangotbanned dangotbanned left a comment

Choose a reason for hiding this comment

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

Looking much better thanks again @joelostblom

I'll approve this now.

You can drop the concepts suggestion if it doesn't seem right, but please commit the spellcheck one

doc/user_guide/interactions/index.rst Outdated Show resolved Hide resolved
doc/user_guide/interactions/index.rst Outdated Show resolved Hide resolved
@joelostblom joelostblom enabled auto-merge (squash) August 31, 2024 18:29
@joelostblom
Copy link
Contributor Author

Thank you! Merging

@joelostblom joelostblom merged commit 5b58779 into main Aug 31, 2024
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@binste binste binste approved these changes

@dangotbanned dangotbanned dangotbanned approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@joelostblom @dangotbanned @binste