-
-
Notifications
You must be signed in to change notification settings - Fork 403
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
Update documentation and small Pixi improvements #6200
Merged
Changes from 30 commits
Commits
Show all changes
42 commits
Select commit
Hold shift + click to select a range
948a9c5
Remove .gitattribute
hoxbro 8a3ef85
Nit changes
hoxbro d61d94b
Fix environment variables in test.yaml
hoxbro a152ec7
Misc updates
hoxbro bd5a837
Sort dependencies in pixi.toml and move some test-core to test
hoxbro 65c2340
Move back plotly to the test-core (for now)
hoxbro 83761b0
Update tests to work without Matplotlib, IPython, and nbconvert
hoxbro 79a7f97
Make plotly a recommended install
hoxbro 8d735a6
Add tests group to optional dependencies
hoxbro 6ab4dcb
Add color to pyargs test
hoxbro 1eee8d7
Change to macos-latest
hoxbro 1ddd20f
Only add a .pth for install
hoxbro 078c8b3
Revert .pth only install
hoxbro 9e3c296
Convert files to md
hoxbro bdd1d91
Update install.md
hoxbro 9f0aed2
Update index.md
hoxbro eb85465
Update configuration documentation
hoxbro b6491f0
Update README.md
hoxbro 997474e
Misc doc updates
hoxbro 267f85f
Try having docs build with mac os to see if it is faster
hoxbro 775f9e4
Split docs up into build and publish
hoxbro 1424c0f
Add test step (tmp)
hoxbro 5ab03f0
Add python-kaleido
hoxbro 7a86b58
Remove some debug statements
hoxbro aded4a7
Update reference on doc/index
hoxbro afbb81b
Add link back to badges
hoxbro 7749b17
Remove debug code
hoxbro abbaf1a
Update coverage for test
hoxbro 1fecadc
Update to not install build steps
hoxbro 4a0742d
Upload UI screenshots
hoxbro 9913e56
Make private tasks
hoxbro c02e869
Update developer guide with pixi task list
hoxbro a833094
Update README.md
hoxbro ed9157e
Clean up download_data.py
hoxbro 2c83ce7
Make pyviz-dev highest channel
hoxbro 48f5c59
Unpin notebook version
hoxbro f77d6ea
Set timeout for nightly lock
hoxbro d3054be
Changes related to ibis 9.0.0
hoxbro dbdeb20
http -> https
hoxbro 0677d67
Small updates to developer guide
hoxbro fe3dd8f
Add upload of nightly lock file to S3
hoxbro f98ef05
Update path
hoxbro File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -20,28 +20,27 @@ on: | |
schedule: | ||
- cron: "0 14 * * SUN" | ||
|
||
defaults: | ||
run: | ||
shell: bash -el {0} | ||
|
||
jobs: | ||
pixi_lock: | ||
name: Pixi lock | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: holoviz-dev/holoviz_tasks/pixi_lock@pixi | ||
|
||
build_docs: | ||
name: Documentation | ||
docs_build: | ||
name: Build Documentation | ||
needs: [pixi_lock] | ||
runs-on: "ubuntu-latest" | ||
timeout-minutes: 120 | ||
defaults: | ||
run: | ||
shell: bash -el {0} | ||
runs-on: "macos-latest" | ||
timeout-minutes: 180 | ||
outputs: | ||
tag: ${{ steps.vars.outputs.tag }} | ||
env: | ||
DESC: "Documentation build" | ||
MPLBACKEND: "Agg" | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} | ||
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} | ||
AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }} | ||
MOZ_HEADLESS: 1 | ||
PANEL_EMBED: "true" | ||
PANEL_EMBED_JSON: "true" | ||
|
@@ -51,22 +50,44 @@ jobs: | |
- uses: holoviz-dev/holoviz_tasks/pixi_install@pixi | ||
with: | ||
environments: docs | ||
- name: Build documentation | ||
run: pixi run -e docs docs-build | ||
- uses: actions/upload-artifact@v4 | ||
if: always() | ||
with: | ||
name: docs | ||
if-no-files-found: error | ||
path: builtdocs | ||
- name: Set output | ||
id: vars | ||
run: echo "tag=${GITHUB_REF#refs/*/}" >> $GITHUB_OUTPUT | ||
- name: Build documentation | ||
run: pixi run -e docs docs-build | ||
|
||
docs_publish: | ||
name: Publish Documentation | ||
runs-on: "ubuntu-latest" | ||
needs: [docs_build] | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }} | ||
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }} | ||
AWS_DEFAULT_REGION: ${{ secrets.AWS_DEFAULT_REGION }} | ||
steps: | ||
- uses: actions/download-artifact@v4 | ||
with: | ||
name: docs | ||
path: builtdocs/ | ||
- name: Set output | ||
id: vars | ||
run: echo "tag=${{ needs.docs_build.outputs.tag }}" >> $GITHUB_OUTPUT | ||
- name: upload dev | ||
if: | | ||
(github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'dev') || | ||
(github.event_name == 'push' && (contains(steps.vars.outputs.tag, 'a') || contains(steps.vars.outputs.tag, 'b') || contains(steps.vars.outputs.tag, 'rc'))) | ||
run: | | ||
pipx install awscli | ||
aws s3 sync --quiet ./builtdocs s3://dev.holoviews.org/ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. AWS is on GitHub Runner by default. |
||
- name: upload main | ||
if: | | ||
(github.event_name == 'workflow_dispatch' && github.event.inputs.target == 'main') || | ||
(github.event_name == 'push' && !(contains(steps.vars.outputs.tag, 'a') || contains(steps.vars.outputs.tag, 'b') || contains(steps.vars.outputs.tag, 'rc'))) | ||
run: | | ||
pipx install awscli | ||
aws s3 sync --quiet ./builtdocs s3://holoviews.org/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,122 @@ | ||
<h1><img src="_static/logo_horizontal.png" style="width: 30%;"></h1> | ||
|
||
**Stop plotting your data - annotate your data and let it visualize | ||
itself.** | ||
|
||
<div style="display: flex"> | ||
<div style="width: 95%"> | ||
|
||
HoloViews is an | ||
[open-source](https://github.com/holoviz/holoviews/blob/main/LICENSE.txt) | ||
Python library designed to make data analysis and visualization seamless | ||
and simple. With HoloViews, you can usually express what you want to do | ||
in very few lines of code, letting you focus on what you are trying to | ||
explore and convey, not on the process of plotting. | ||
|
||
For examples, check out the thumbnails below and the other items in the | ||
[Gallery](gallery/index) of demos and apps and the [Reference Gallery](reference/index) | ||
that shows every HoloViews component. Be sure to | ||
look at the code, not just the pictures, to appreciate how easy it is to | ||
create such plots yourself! | ||
|
||
The [Getting-Started](getting_started/index) guide explains the basic concepts | ||
and how to start using HoloViews, and is the recommended way to | ||
understand how everything works. | ||
|
||
The [User Guide](user_guide/index) goes more deeply into key concepts from | ||
HoloViews, when you are ready for further study. | ||
|
||
The [API](reference_manual) is the definitive guide to each HoloViews | ||
object, but the same information is available more conveniently via the | ||
`hv.help()` command and tab completion in the Jupyter notebook. | ||
|
||
If you have any [issues](https://github.com/holoviz/holoviews/issues) or | ||
wish to [contribute code](https://help.github.com/articles/about-pull-requests), you can | ||
visit our [GitHub site](https://github.com/holoviz/holoviews), file a | ||
topic on the [HoloViz Discourse](https://discourse.holoviz.org/), or ask a quick question | ||
on [Holoviz Discord](https://discord.gg/AXRHnJU6sP). | ||
|
||
</div> | ||
|
||
</div> | ||
<hr width='100%'></hr> | ||
|
||
<div> | ||
<div > | ||
<a href="https://holoviews.org/gallery/demos/bokeh/iris_splom_example.html"> | ||
<img src="https://holoviews.org/_images/iris_splom_example.png" width='24%'> </img> </a> | ||
<a href="https://holoviews.org/getting_started/Gridded_Datasets.html"> | ||
<img src="https://assets.holoviews.org/collage/cells.png" width='27%'> </img> </a> | ||
<a href="https://holoviews.org/gallery/demos/bokeh/scatter_economic.html"> | ||
<img src="https://holoviews.org/_images/scatter_economic.png" width='47%'> </img> </a> | ||
</div> | ||
|
||
<div > | ||
<a href="https://holoviews.org/gallery/demos/bokeh/square_limit.html"> | ||
<img src="https://holoviews.org/_images/square_limit.png" width='24%'> </a> | ||
<a href="https://holoviews.org/gallery/demos/bokeh/bars_economic.html"> | ||
<img src="https://holoviews.org/_images/bars_economic.png" width='24%'> </a> | ||
<a href="https://holoviews.org/gallery/demos/bokeh/texas_choropleth_example.html"> | ||
<img src="https://holoviews.org/_images/texas_choropleth_example.png" width='24%'> </a> | ||
<a href="https://holoviews.org/gallery/demos/bokeh/verhulst_mandelbrot.html"> | ||
<img src="https://holoviews.org/_images/verhulst_mandelbrot.png" width='24%'> </a> | ||
</div> | ||
<div > | ||
<a href="https://holoviews.org/gallery/demos/bokeh/dropdown_economic.html"> | ||
<img src="https://assets.holoviews.org/collage/dropdown.gif" width='33%'> </a> | ||
<a href="https://holoviews.org/gallery/demos/bokeh/dragon_curve.html"> | ||
<img src="https://assets.holoviews.org/collage/dragon_fractal.gif" width='30%'> </a> | ||
<a href="https://holoviews.org/gallery/apps/bokeh/nytaxi_hover.html"> | ||
<img src="https://assets.holoviews.org/collage/ny_datashader.gif" width='33%'> </a> | ||
</div> | ||
</div> | ||
|
||
# Installation | ||
|
||
[](https://anaconda.org/pyviz/holoviews) | ||
[](https://pypi.python.org/pypi/holoviews) | ||
[](https://github.com/holoviz/holoviews/blob/main/LICENSE.txt) | ||
[](https://codecov.io/gh/holoviz/holoviews) | ||
|
||
HoloViews works with Python 3 on Linux, Windows, or Mac, and works | ||
seamlessly with [Jupyter Notebook and JupyterLab](https://jupyter.org). | ||
|
||
You can install HoloViews either with `conda` or `pip`, for more information see the [install guide](install). | ||
|
||
conda install holoviews | ||
|
||
pip install holoviews | ||
|
||
# Usage | ||
|
||
Once you've installed HoloViews, you can get a copy of all the examples | ||
shown on this website: | ||
|
||
holoviews --install-examples | ||
cd holoviews-examples | ||
|
||
Now you can launch Jupyter Notebook or JupyterLab to explore them: | ||
|
||
jupyter notebook | ||
|
||
jupyter lab | ||
|
||
After you have successfully installed and configured HoloViews, please | ||
see [Getting Started](getting_started/index). | ||
|
||
```{toctree} | ||
:titlesonly: | ||
:hidden: | ||
:maxdepth: 2 | ||
|
||
Home | ||
Getting Started <getting_started/index> | ||
User Guide <user_guide/index> | ||
Gallery <gallery/index> | ||
Reference Gallery <reference/index> | ||
Developer Guide <developer_guide/index> | ||
Releases <releases> | ||
API <reference_manual/index> | ||
FAQ Roadmap <roadmap> | ||
About <about> | ||
``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not sure if this is actually needed.