Skip to content

Commit

Permalink
doc build for commit 4a2e7f1014b17d538d812027e21c57ac223fdf1c
Browse files Browse the repository at this point in the history
  • Loading branch information
binste committed Mar 30, 2024
1 parent 901e77f commit 267b1ac
Show file tree
Hide file tree
Showing 890 changed files with 60,400 additions and 56,505 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: a42202266ffc617f83cac0e3aceb5c36
config: 4ebfb4c88516a1cb411d779ec98bfe19
tags: 645f666f9bcd5a90fca523b33c5a78b7
125 changes: 1 addition & 124 deletions _sources/about/code_of_conduct.rst.txt
Original file line number Diff line number Diff line change
@@ -1,127 +1,4 @@
Code of Conduct
===============

Our Pledge
----------
We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

Our Standards
-------------
Examples of behavior that contributes to a positive environment for our
community include:

- Demonstrating empathy and kindness toward other people
- Being respectful of differing opinions, viewpoints, and experiences
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
- Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of
any kind
- Trolling, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or email address,
without their explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

Enforcement Responsibilities
----------------------------
Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

Scope
-----
This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

Enforcement
-----------
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[email protected].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

Enforcement Guidelines
----------------------
Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

1. Correction
~~~~~~~~~~~~~
**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

2. Warning
~~~~~~~~~~
**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

3. Temporary Ban
~~~~~~~~~~~~~~~~
**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

4. Permanent Ban
~~~~~~~~~~~~~~~~
**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

Attribution
-----------
This Code of Conduct is adapted from the `Contributor Covenant <https://www.contributor-covenant.org>`_,
version 2.1, available at
`https://www.contributor-covenant.org/version/2/1/code_of_conduct.html <https://www.contributor-covenant.org/version/2/1/code_of_conduct.html>`_.

Community Impact Guidelines were inspired by
`Mozilla's code of conduct enforcement ladder <https://github.com/mozilla/diversity>`_.

For answers to common questions about this code of conduct, see the FAQ at
`https://www.contributor-covenant.org/faq <https://www.contributor-covenant.org/faq>`_. Translations are available at
`https://www.contributor-covenant.org/translations <https://www.contributor-covenant.org/translations>`_.
As a project of the Vega Organization, we use the `Vega Code of Conduct <https://github.com/vega/.github/blob/main/CODE_OF_CONDUCT.md>`.
7 changes: 3 additions & 4 deletions _sources/about/governance.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,10 @@ Vega-Altair's governance structure is based on GitHub's
Organizational Governance
-------------------------
The Altair-Viz organization is governed by the documents that reside in the
`governance/org-docs <https://github.com/altair-viz/altair/tree/main/governance/org-docs>`_ directory of the
Vega-Altair GitHub repository.
`Vega Organizational GitHub repository <https://github.com/vega/.github/>`_.

Project Governance
------------------
The Vega-Altair library is governed by the documents that reside in the
`governance/project-docs <https://github.com/altair-viz/altair/tree/main/governance/project-docs>`_ directory of
the Vega-Altair GitHub repository.
`project-docs <https://github.com/vega/.github/blob/main/project-docs/>`_ directory of
the Vega Organizational GitHub repository.
12 changes: 6 additions & 6 deletions _sources/about/roadmap.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ Areas of focus:

* Standardize the API of methods that convert charts into other formats (``alt.Chart().to_<format>``).

* Add type hints to the public API and most of the internals so that users can type check their Altair
* **Released in 5.2:** *Add type hints to the public API and most of the internals so that users can type check their Altair
code with a static type checker such as mypy. This will also make it easier for other packages to
integrate with Altair.
integrate with Altair.*

Documentation
-------------
Expand Down Expand Up @@ -106,8 +106,8 @@ Areas of focus:
Map Tile Support
----------------
We want Vega-Altair to provide first-class support for displaying map tiles from
xyz tile providers like OpenStreetMap. Early development is in progress in the
`altair_tiles <https://github.com/altair-viz/altair_tiles>`_ repository.
xyz tile providers like OpenStreetMap. We've released a first version of
`altair_tiles <https://github.com/altair-viz/altair_tiles>`_ to accomplish this. Feedback is very welcome!

Scale/Performance Improvements
------------------------------
Expand Down Expand Up @@ -150,9 +150,9 @@ workflows.

Areas of focus:

* Support configurable pixel density in PNG image export *(VC)*.
* **Released in 5.1:** *Support configurable pixel density in PNG image export* *(VC)*.

* Support exporting charts to vector PDF files with embedded text *(VC)*.
* **Released in 5.2:** *Support exporting charts to vector PDF files with embedded text* *(VC)*.

.. toctree::
:maxdepth: 1
Expand Down
10 changes: 6 additions & 4 deletions _sources/case_studies/numpy-tooltip-images.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,11 @@ you’ll learn how to display images stored as Numpy arrays
in tooltips with any Altair chart.

First,
we create some example image arrays with blobs of different sizes.
we create some example image arrays with blobs (objects)
of different sizes and shapes (circular and square).
We measure the area of the blobs
in order to have a quantitative measurement to plot.
in order to have a quantitative measurement
to compare them with in our charts.

.. altair-plot::
:output: repr
Expand Down Expand Up @@ -40,7 +42,7 @@ in order to have a quantitative measurement to plot.
'group': rng.choice(['a', 'b', 'c'], size=n_rows)
})
# Compute the area as the proportion of pixels above a threshold
df[['image1_area', 'image2_area']] = df[['image1', 'image2']].applymap(lambda x: (x > 0.4).mean())
df[['image1_area', 'image2_area']] = df[['image1', 'image2']].map(lambda x: (x > 0.4).mean())
df

Next, we define the function
Expand Down Expand Up @@ -150,7 +152,7 @@ instead of both the images concatenated together.
return f"data:image/png;base64,{img_str}"

# The column with the base64 image string must be called "image" in order for it to trigger the image rendering in the tooltip
df[['image1_base64', 'image2_base64']] = df[['image1', 'image2']].applymap(create_tooltip_image)
df[['image1_base64', 'image2_base64']] = df[['image1', 'image2']].map(create_tooltip_image)
# Dropping the image arrays since they are large an no longer needed
# Also drop the previous tooltip image for clarity
df_plot = df.drop(columns=['image1', 'image2', 'image'])
Expand Down
14 changes: 7 additions & 7 deletions _sources/gallery/airport_connections.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Connections Among U.S. Airports Interactive
-------------------------------------------
This example shows all the connections between major U.S. airports. Lookup transformations
are used to find the coordinates of each airport and connecting airports. Connections
are displayed on mouseover via a single selection.
are displayed on pointerover via a single selection.


.. altair-plot::
Expand All @@ -28,9 +28,9 @@ are displayed on mouseover via a single selection.

states = alt.topo_feature(data.us_10m.url, feature="states")

# Create mouseover selection
# Create pointerover selection
select_city = alt.selection_point(
on="mouseover", nearest=True, fields=["origin"], empty=False
on="pointerover", nearest=True, fields=["origin"], empty=False
)

# Define which attributes to lookup from airports.csv
Expand Down Expand Up @@ -100,9 +100,9 @@ are displayed on mouseover via a single selection.
states = alt.topo_feature(data.us_10m.url, feature="states")
# Create mouseover selection
# Create pointerover selection
select_city = alt.selection_point(
on="mouseover", nearest=True, fields=["origin"], empty=False
on="pointerover", nearest=True, fields=["origin"], empty=False
)
# Define which attributes to lookup from airports.csv
Expand Down Expand Up @@ -170,9 +170,9 @@ are displayed on mouseover via a single selection.
states = alt.topo_feature(data.us_10m.url, feature="states")
# Create mouseover selection
# Create pointerover selection
select_city = alt.selection_point(
on="mouseover", nearest=True, fields=["origin"], empty=False
on="pointerover", nearest=True, fields=["origin"], empty=False
)
# Define which attributes to lookup from airports.csv
Expand Down
78 changes: 78 additions & 0 deletions _sources/gallery/histogram_gradient_color.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@

:orphan:
:html_theme.sidebar_secondary.remove:

.. This document is auto-generated by the altair-gallery extension. Do not modify directly.
.. _gallery_histogram_gradient_color:


Histogram with Gradient Color
-----------------------------
This example shows how to make a histogram with gradient color.
The low-high IMDB rating is represented with the color scheme `pinkyellowgreen`.


.. altair-plot::
:remove-code:



import altair as alt
from vega_datasets import data

source = data.movies.url

alt.Chart(source).mark_bar().encode(
alt.X("IMDB_Rating:Q",
bin=alt.Bin(maxbins=20),
scale=alt.Scale(domain=[1, 10])
),
alt.Y('count()'),
alt.Color("IMDB_Rating:Q",
bin=alt.Bin(maxbins=20),
scale=alt.Scale(scheme='pinkyellowgreen')
)
)

.. tab-set::

.. tab-item:: Method syntax
:sync: method

.. code:: python
import altair as alt
from vega_datasets import data
source = data.movies.url
alt.Chart(source).mark_bar().encode(
alt.X("IMDB_Rating:Q").bin(maxbins=20).scale(domain=[1, 10]),
alt.Y('count()'),
alt.Color("IMDB_Rating:Q").bin(maxbins=20).scale(scheme='pinkyellowgreen')
)
.. tab-item:: Attribute syntax
:sync: attribute

.. code:: python
import altair as alt
from vega_datasets import data
source = data.movies.url
alt.Chart(source).mark_bar().encode(
alt.X("IMDB_Rating:Q",
bin=alt.Bin(maxbins=20),
scale=alt.Scale(domain=[1, 10])
),
alt.Y('count()'),
alt.Color("IMDB_Rating:Q",
bin=alt.Bin(maxbins=20),
scale=alt.Scale(scheme='pinkyellowgreen')
)
)
Loading

0 comments on commit 267b1ac

Please sign in to comment.