v2-docs: Switch to pydata-sphinx theme (#537)

* use pydata-sphinx theme, add old blog posts * switch to pydata sphinx theme * remove unused file
vega · Nov 12, 2024 · 832dc2f · 832dc2f
1 parent 7a7477e
commit 832dc2f
Show file tree

Hide file tree

Showing 33 changed files with 1,513 additions and 137 deletions.
diff --git a/docs/source/_static/custom.css b/docs/source/_static/custom.css
@@ -1,3 +1,8 @@
+:root {
+    /* Make the table hover background lighter */
+    --pst-color-table-row-hover-bg: color-mix(in srgb, #6432bd 30%, transparent) !important;
+}
+
 .sidebar-logo {
     max-width: 100px;
     width: auto;
@@ -11,50 +16,32 @@ table.docutils th {
     color: white;
 }
 
-/* Make dropdown rounded pill and fit in cell */
-table.docutils td {
-    padding: 0
+/* make dropdown background transparent, and fit in cell */
+details.sd-dropdown summary.sd-card-header {
+    border: 0 !important;
+    background-color: transparent !important;
+    border-radius: 0 !important;   
 }
 
 details.sd-dropdown {
-    margin-top: 0.4em;
-    margin-bottom: 0.4em !important;
-    border: 0;
+    box-shadow: none !important;
 }
 
-details.sd-dropdown>.sd-card-header {
-    border: 0 !important;
-    background-color: var(--color-table-border) !important;
-    border-radius: 1em !important;
-    padding: 0 .4em 0 .8em !important;
-    margin: 0 0.8em 0 0.6em !important;
+details.sd-dropdown summary.sd-summary-title {
+    width: fit-content;
+    padding: .2em .3em .2em .4em;
+    font-weight: normal !important;
 }
 
-details.sd-card {
-    background-color: transparent;
-    box-shadow: none;
+.sd-mb-3, .sd-my-3 {
+    margin: 0 !important;
 }
 
-summary.sd-summary-title {
-    font-weight: normal !important;
+summary.sd-card-header+div.sd-summary-content {
+    background-color: transparent !important;
 }
 
-
 /* Center the contents of the second column */
-table.docutils td:nth-child(2) {
+table.table td:nth-child(2) {
     text-align: center;
 }
-
-table.docutils td:first-child {
-    padding-left: 0.5rem;
-    padding-right: 0.5rem;
-}
-
-/* Round corners of the first and last column headers */
-table.docutils th:first-child {
-    border-radius: 0.5rem 0 0 0;
-}
-
-table.docutils th:last-child {
-    border-radius: 0 0.5rem 0 0;
-}
diff --git a/docs/source/about_the_name.md → docs/source/about/about_the_name.md b/docs/source/about_the_name.md → docs/source/about/about_the_name.md
diff --git a/docs/source/background.md → docs/source/about/background.md b/docs/source/background.md → docs/source/about/background.md
@@ -15,4 +15,19 @@ There are at least two significant advantages to having data transformations and
 ## Motivation for VegaFusion
 Vega makes it possible to create declarative JSON specifications of rich interactive visualizations that are fully self-contained. They can run entirely in a web browser without requiring access to an external database or a Python library like Pandas.
 
-For datasets of a few tens of thousands rows or fewer, this architecture often results in extremely smooth and responsive interactivity. However, this architecture doesn't scale very well to datasets of hundreds of thousands of rows or more.  This is the gap VegaFusion aims to fill.
+For datasets of a few tens of thousands rows or fewer, this architecture often results in extremely smooth and responsive interactivity. However, this architecture doesn't scale very well to datasets of hundreds of thousands of rows or more.  This is the gap VegaFusion aims to fill.
+
+:::{toctree}
+:maxdepth: 1
+:hidden: true
+:caption: About
+
+self
+how_it_works
+technology
+related_projects
+about_the_name
+license
+stewardship
+citation
+:::
diff --git a/docs/source/citation.md → docs/source/about/citation.md b/docs/source/citation.md → docs/source/about/citation.md
diff --git a/docs/source/how_it_works.md → docs/source/about/how_it_works.md b/docs/source/how_it_works.md → docs/source/about/how_it_works.md
diff --git a/docs/source/license.md → docs/source/about/license.md b/docs/source/license.md → docs/source/about/license.md
diff --git a/docs/source/related_projects.md → docs/source/about/related_projects.md b/docs/source/related_projects.md → docs/source/about/related_projects.md
diff --git a/docs/source/stewardship.md → docs/source/about/stewardship.md b/docs/source/stewardship.md → docs/source/about/stewardship.md
@@ -1,9 +1,2 @@
 # Stewardship
 VegaFusion was developed by [Jon Mease](https://jonmmease.dev/) and acquired by [Hex Technologies](https://hex.tech/) in 2022. Hex donated VegaFusion to the Vega Project in 2024 and continues to support its development and maintenance.
-
-```{image} https://user-images.githubusercontent.com/15064365/213193272-b9617431-84a0-4733-8b58-1309d25e925b.svg
-:alt: Hex Logo
-:width: 200px
-:align: center
-:target: https://hex.tech
-```
diff --git a/docs/source/technology.md → docs/source/about/technology.md b/docs/source/technology.md → docs/source/about/technology.md
diff --git a/docs/source/community/governance.md b/docs/source/community/governance.md
@@ -0,0 +1,15 @@
+# Governance
+The VegaFusion project is governed by the documents that reside in the [project-docs](https://github.com/vega/.github/tree/main/project-docs) directory of the Vega Organizational GitHub repository.
+
+:::{toctree}
+:maxdepth: 1
+:hidden: true
+:caption: "Community"
+
+self
+Changelog <https://github.com/vega/vegafusion/releases>
+Source Code <https://github.com/vega/vegafusion/>
+Report an Issue <https://github.com/vega/vegafusion/issues>
+Start a Discussion <https://github.com/vega/vegafusion/discussions>
+Code of Conduct <https://github.com/vega/.github/blob/main/CODE_OF_CONDUCT.md>
+:::
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -8,18 +8,32 @@
     'sphinx.ext.autodoc',
     'sphinx.ext.napoleon',
     'sphinx_design',
+    'ablog',
+    'sphinx.ext.intersphinx',
 ]
 
 # Theme settings
-html_theme = 'furo'
+html_theme = "pydata_sphinx_theme"
 html_static_path = ['_static']
 html_logo = "_static/VegaFusionLogo-Color.svg"
 html_favicon = "_static/favicon.ico"
 
+# Add custom CSS
+html_css_files = [
+    'custom.css',
+] 
+
 _social_img = "https://vegafusion.io/_static/vegafusion_social.png"
 _description = "VegaFusion provides serverside scaling for Vega visualizations"
 _title = "VegaFusion"
 
+# -- Blog configuration ------------------------------------------------------
+blog_baseurl = "https://vegafusion.io"  # Replace with your actual base URL
+blog_post_pattern = "posts/*/*"
+blog_path = "blog"
+blog_title = "VegaFusion Blog"
+templates_path = ['_templates']
+
 # MyST settings
 myst_enable_extensions = [
     "colon_fence",    # Allow ::: for admonitions
@@ -29,7 +43,3 @@
     "attrs_inline",   # Inline attributes
 ]
 
-# Add custom CSS
-html_css_files = [
-    'custom.css',
-] 
diff --git a/docs/source/chart_state.md → docs/source/features/chart_state.md b/docs/source/chart_state.md → docs/source/features/chart_state.md
diff --git a/docs/source/column_usage.md → docs/source/features/column_usage.md b/docs/source/column_usage.md → docs/source/features/column_usage.md
diff --git a/docs/source/features/features.md b/docs/source/features/features.md
@@ -0,0 +1,18 @@
+# Features
+
+VegaFusion provides a variety of low-level features that can be used to build higher-level Vega systems that need to scale to larger datasets than Vega handles natively.
+
+```{toctree}
+:maxdepth: 1
+:caption: Features
+:hidden: true
+
+column_usage
+transform_data
+transform_spec
+transform_extract
+chart_state
+inline_datasets
+grpc
+vega-lite
+```
diff --git a/docs/source/grpc.md → docs/source/features/grpc.md b/docs/source/grpc.md → docs/source/features/grpc.md
diff --git a/docs/source/inline_datasets.md → docs/source/features/inline_datasets.md b/docs/source/inline_datasets.md → docs/source/features/inline_datasets.md
diff --git a/docs/source/transform_data.md → docs/source/features/transform_data.md b/docs/source/transform_data.md → docs/source/features/transform_data.md
diff --git a/docs/source/transform_extract.md → docs/source/features/transform_extract.md b/docs/source/transform_extract.md → docs/source/features/transform_extract.md
diff --git a/docs/source/transform_spec.md → docs/source/features/transform_spec.md b/docs/source/transform_spec.md → docs/source/features/transform_spec.md
diff --git a/docs/source/vega-lite.md → docs/source/features/vega-lite.md b/docs/source/vega-lite.md → docs/source/features/vega-lite.md
diff --git a/docs/source/governance.md b/docs/source/governance.md
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -24,52 +24,26 @@ The VegaFusion project provides Rust, Python, and JavaScript libraries for analy
 If you've arrived here looking for information on how to scale Vega-Altair visualizations to support larger datasets, see the Vega-Altair documentation on the [`"vegafusion"` data transformer](https://altair-viz.github.io/user_guide/large_datasets.html#vegafusion-data-transformer).
 :::
 
-```{toctree}
-:maxdepth: 1
-:caption: Features
-
-column_usage
-transform_data
-transform_spec
-transform_extract
-chart_state
-inline_datasets
-grpc
-vega-lite
-```
+# Python Installation
 
-```{toctree}
-:maxdepth: 2
-:hidden: true
-:caption: Vega Coverage
+The VegaFusion Python package can be installed into a Python environment using pip
 
-supported_transforms
-supported_expressions
+```bash
+pip install vegafusion
 ```
 
-```{toctree}
-:maxdepth: 2
-:hidden: true
-:caption: About
+or conda
 
-background
-how_it_works
-technology
-related_projects
-about_the_name
-license
-stewardship
-citation
+```bash
+conda install -c conda-forge vegafusion
 ```
 
 ```{toctree}
 :maxdepth: 1
 :hidden: true
-:caption: "Community"
 
-Source Code <https://github.com/vega/vegafusion/>
-Report an Issue <https://github.com/vega/vegafusion/issues>
-Start a Discussion <https://github.com/vega/vegafusion/discussions>
-Code of Conduct <https://github.com/vega/.github/blob/main/CODE_OF_CONDUCT.md>
-governance
+features/features
+Vega Coverage <vega_coverage/supported_transforms>
+About <about/background>
+Community <community/governance>
 ```
diff --git a/docs/source/posts/2022/2022-01-19_Release_0.0.1.md b/docs/source/posts/2022/2022-01-19_Release_0.0.1.md
@@ -0,0 +1,7 @@
+---
+date: 2022-01-19 
+category: Release
+---
+
+# Announcing VegaFusion 0.0.1
+The first public version of VegaFusion has been released as 0.0.1.  Full project announcement to follow!