adds html metadata to all doc sections (catherinedevlin#207)

pmfischer · Mar 4, 2023 · a097147 · a097147
1 parent 243d719
commit a097147
Show file tree

Hide file tree

Showing 23 changed files with 96 additions and 1 deletion.
diff --git a/doc/api/configuration.md b/doc/api/configuration.md
@@ -11,6 +11,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Configure the %sql/%%sql magics in Jupyter
+  keywords: jupyter, sql, jupysql
+  property=og:locale: en_US
 ---
 
 # `%sql` Configuration

diff --git a/doc/api/magic-plot.md b/doc/api/magic-plot.md
@@ -9,6 +9,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Documentation for the %sqlplot magic from JupySQL
+  keywords: jupyter, sql, jupysql, plotting
+  property=og:locale: en_US
 ---
 
 # `%sqlplot`

diff --git a/doc/api/magic-render.md b/doc/api/magic-render.md
@@ -9,6 +9,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Documentation for the %sqlrender magic from JupySQL
+  keywords: jupyter, sql, jupysql
+  property=og:locale: en_US
 ---
 
 # `%sqlrender`

diff --git a/doc/api/magic-sql.md b/doc/api/magic-sql.md
@@ -9,6 +9,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Documentation for the %sql and %%sql magics from JupySQL
+  keywords: jupyter, sql, jupysql
+  property=og:locale: en_US
 ---
 
 # `%sql`/`%%sql`

diff --git a/doc/community/developer-guide.md b/doc/community/developer-guide.md
@@ -9,6 +9,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: JupySQL's developer guide
+  keywords: jupyter, sql, jupysql
+  property=og:locale: en_US
 ---
 
 # Developer guide

diff --git a/doc/compose.md b/doc/compose.md
@@ -9,6 +9,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: "Use JupySQL to organize large SQL queries in a Jupyter notebook"
+  keywords: "jupyter, sql, jupysql"
+  property=og:locale: "en_US"
 ---
 
 # Organizing large queries

diff --git a/doc/connecting.md b/doc/connecting.md
@@ -11,6 +11,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: "Connect to a SQL database from a Jupyter notebook"
+  keywords: "jupyter, sql, jupysql"
+  property=og:locale: "en_US"
 ---
 
 # Connecting

diff --git a/doc/csv.md b/doc/csv.md
@@ -11,6 +11,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: "Export results from a SQL query to a CSV file from Jupyter"
+  keywords: "jupyter, sql, jupysql, csv"
+  property=og:locale: "en_US"
 ---
 
 # Export to CSV

diff --git a/doc/howto.md b/doc/howto.md
@@ -9,6 +9,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Recipes for JupySQL
+  keywords: jupyter, sql, jupysql
+  property=og:locale: en_US
 ---
 
 ```{code-cell} ipython3

diff --git a/doc/howto/json.md b/doc/howto/json.md
@@ -9,6 +9,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Use JupySQL and DuckDB to query JSON files with SQL
+  keywords: jupyter, sql, jupysql, json, duckdb
+  property=og:locale: en_US
 ---
 
 # Run SQL on JSON files

diff --git a/doc/howto/postgres-connect.ipynb b/doc/howto/postgres-connect.ipynb
@@ -769,6 +769,11 @@
   }
  ],
  "metadata": {
+  "html_meta": {
+   "description lang=en": "Query a PostgreSQL database from Jupyter via JupySQL",
+   "keywords": "jupyter, sql, jupysql, postgres",
+   "property=og:locale": "en_US"
+  },
   "kernelspec": {
    "display_name": "Python 3 (ipykernel)",
    "language": "python",
@@ -784,7 +789,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.10.8"
+   "version": "3.9.16"
   }
  },
  "nbformat": 4,

diff --git a/doc/howto/syntax-highlighting.md b/doc/howto/syntax-highlighting.md
@@ -9,6 +9,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Enable SQL syntax highlighting in JupyterLab
+  keywords: jupyter, jupyterlab, sql
+  property=og:locale: en_US
 ---
 
 # SQL syntax highlighting

diff --git a/doc/integrations/duckdb.md b/doc/integrations/duckdb.md
@@ -9,6 +9,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Use DuckDB from Jupyter using JupySQL
+  keywords: jupyter, sql, jupysql, duckdb, plotting
+  property=og:locale: en_US
 ---
 
 # DuckDB integration

diff --git a/doc/integrations/mssql.ipynb b/doc/integrations/mssql.ipynb
@@ -1063,6 +1063,11 @@
   }
  ],
  "metadata": {
+  "html_meta": {
+   "description lang=en": "Query a Microsoft SQL Server from Jupyter via JupySQL",
+   "keywords": "jupyter, sql, jupysql, mssql, sql server",
+   "property=og:locale": "en_US"
+  },
   "kernelspec": {
    "display_name": "Python 3 (ipykernel)",
    "language": "python",

diff --git a/doc/integrations/mysql.ipynb b/doc/integrations/mysql.ipynb
@@ -561,6 +561,11 @@
   }
  ],
  "metadata": {
+  "html_meta": {
+   "description lang=en": "Query a MySQL database from Jupyter via JupySQL",
+   "keywords": "jupyter, sql, jupysql, mysql",
+   "property=og:locale": "en_US"
+  },
   "kernelspec": {
    "display_name": "Python 3 (ipykernel)",
    "language": "python",

diff --git a/doc/integrations/pandas.md b/doc/integrations/pandas.md
@@ -11,6 +11,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Convert outputs from SQL queries to pandas data frames using JupySQL
+  keywords: jupyter, sql, jupysql, pandas
+  property=og:locale: en_US
 ---
 
 # Pandas integration

diff --git a/doc/integrations/polars.md b/doc/integrations/polars.md
@@ -11,6 +11,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Convert outputs from SQL queries to polars data frames using JupySQL
+  keywords: jupyter, sql, jupysql, polars
+  property=og:locale: en_US
 ---
 
 # Polars integration

diff --git a/doc/intro.md b/doc/intro.md
@@ -11,6 +11,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Run SQL in a Jupyter notebook with JupySQL
+  keywords: jupyter, sql, jupysql
+  property=og:locale: en_US
 ---
 
 # Introduction

diff --git a/doc/plot-legacy.md b/doc/plot-legacy.md
@@ -11,6 +11,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Create line, bar and pie charts from SQL queries in a Jupyter notebook using JupySQL
+  keywords: jupyter, sql, jupysql, plotting, matplotlib
+  property=og:locale: en_US
 ---
 
 # Plotting (legacy API)

diff --git a/doc/plot.md b/doc/plot.md
@@ -9,6 +9,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Create visualizations for large-scale datasets in a Jupyter notebook using JupySQL
+  keywords: jupyter, sql, jupysql, plotting, warehouse, duckdb
+  property=og:locale: en_US
 ---
 
 # Plotting

diff --git a/doc/quick-start.md b/doc/quick-start.md
@@ -11,6 +11,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: "Quickstart for JupySQL: a package to run SQL in Jupyter"
+  keywords: jupyter, sql, jupysql
+  property=og:locale: en_US
 ---
 
 # Quick Start

diff --git a/doc/user-guide/tables-columns.md b/doc/user-guide/tables-columns.md
@@ -9,6 +9,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: List tables and columns from your database in Jupyter via JupySQL
+  keywords: jupyter, sql, jupysql
+  property=og:locale: en_US
 ---
 
 # List tables and columns

diff --git a/doc/user-guide/template.md b/doc/user-guide/template.md
@@ -9,6 +9,10 @@ kernelspec:
   display_name: Python 3 (ipykernel)
   language: python
   name: python3
+html_meta:
+  description lang=en: Templatize SQL queries in Jupyter via JupySQL
+  keywords: jupyter, sql, jupysql, jinja
+  property=og:locale: en_US
 ---
 
 # Template