Generate static documentation pages & update the CI (#1116)

* Generate static documentation pages & update the CI * Change CI so that changes are committed & pushed * Make it so that only python v3.10 triggers doc generation * Fix yaml syntax * PR feedback, fix push action
tobymao · Feb 7, 2023 · e40ef9a · e40ef9a
1 parent 2e7cf05
commit e40ef9a
Show file tree

Hide file tree

Showing 67 changed files with 140,860 additions and 2 deletions.
diff --git a/.github/workflows/python-package.yml b/.github/workflows/python-package.yml
@@ -22,5 +22,17 @@ jobs:
         python -m pip install --upgrade pip
         make install-dev
     - name: Run checks (linter, code style, tests)
+      run: make check
+    - name: Update documentation
       run: |
-        make check
+        make docs
+        git add docs
+        git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+        git config --local user.name "github-actions[bot]"
+        git commit -m "CI: Auto-generated documentation" -a | exit 0
+      if: ${{ matrix.python-version == '3.10' && github.event_name == 'push' }}
+    - name: Push changes
+      if: ${{ matrix.python-version == '3.10' && github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+      uses: ad-m/github-push-action@master
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
diff --git a/Makefile b/Makefile
@@ -18,7 +18,7 @@ style:
 check: style test
 
 docs:
-	python pdoc/cli.py -o pdoc/docs
+	python pdoc/cli.py -o docs
 
 docs-serve:
 	python pdoc/cli.py
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,7 @@
+<!doctype html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <meta http-equiv="refresh" content="0; url=./sqlglot.html"/>
+</head>
+</html>
diff --git a/docs/search.js b/docs/search.js
diff --git a/docs/sqlglot.html b/docs/sqlglot.html
diff --git a/docs/sqlglot/dataframe.html b/docs/sqlglot/dataframe.html
diff --git a/docs/sqlglot/dataframe/sql.html b/docs/sqlglot/dataframe/sql.html
diff --git a/docs/sqlglot/dialects.html b/docs/sqlglot/dialects.html
diff --git a/docs/sqlglot/dialects/bigquery.html b/docs/sqlglot/dialects/bigquery.html
diff --git a/docs/sqlglot/dialects/clickhouse.html b/docs/sqlglot/dialects/clickhouse.html
diff --git a/docs/sqlglot/dialects/databricks.html b/docs/sqlglot/dialects/databricks.html
diff --git a/docs/sqlglot/dialects/dialect.html b/docs/sqlglot/dialects/dialect.html
diff --git a/docs/sqlglot/dialects/drill.html b/docs/sqlglot/dialects/drill.html
diff --git a/docs/sqlglot/dialects/duckdb.html b/docs/sqlglot/dialects/duckdb.html
diff --git a/docs/sqlglot/dialects/hive.html b/docs/sqlglot/dialects/hive.html
diff --git a/docs/sqlglot/dialects/mysql.html b/docs/sqlglot/dialects/mysql.html
diff --git a/docs/sqlglot/dialects/oracle.html b/docs/sqlglot/dialects/oracle.html
diff --git a/docs/sqlglot/dialects/postgres.html b/docs/sqlglot/dialects/postgres.html
diff --git a/docs/sqlglot/dialects/presto.html b/docs/sqlglot/dialects/presto.html
diff --git a/docs/sqlglot/dialects/redshift.html b/docs/sqlglot/dialects/redshift.html
diff --git a/docs/sqlglot/dialects/snowflake.html b/docs/sqlglot/dialects/snowflake.html
diff --git a/docs/sqlglot/dialects/spark.html b/docs/sqlglot/dialects/spark.html
diff --git a/docs/sqlglot/dialects/sqlite.html b/docs/sqlglot/dialects/sqlite.html
diff --git a/docs/sqlglot/dialects/starrocks.html b/docs/sqlglot/dialects/starrocks.html
diff --git a/docs/sqlglot/dialects/tableau.html b/docs/sqlglot/dialects/tableau.html
diff --git a/docs/sqlglot/dialects/teradata.html b/docs/sqlglot/dialects/teradata.html
diff --git a/docs/sqlglot/dialects/trino.html b/docs/sqlglot/dialects/trino.html
diff --git a/docs/sqlglot/dialects/tsql.html b/docs/sqlglot/dialects/tsql.html
diff --git a/docs/sqlglot/diff.html b/docs/sqlglot/diff.html
diff --git a/docs/sqlglot/errors.html b/docs/sqlglot/errors.html
diff --git a/docs/sqlglot/executor.html b/docs/sqlglot/executor.html
diff --git a/docs/sqlglot/executor/context.html b/docs/sqlglot/executor/context.html
diff --git a/docs/sqlglot/executor/env.html b/docs/sqlglot/executor/env.html
diff --git a/docs/sqlglot/executor/python.html b/docs/sqlglot/executor/python.html
diff --git a/docs/sqlglot/executor/table.html b/docs/sqlglot/executor/table.html
diff --git a/docs/sqlglot/expressions.html b/docs/sqlglot/expressions.html
diff --git a/docs/sqlglot/generator.html b/docs/sqlglot/generator.html
diff --git a/docs/sqlglot/helper.html b/docs/sqlglot/helper.html
diff --git a/docs/sqlglot/lineage.html b/docs/sqlglot/lineage.html
diff --git a/docs/sqlglot/optimizer.html b/docs/sqlglot/optimizer.html
diff --git a/docs/sqlglot/optimizer/annotate_types.html b/docs/sqlglot/optimizer/annotate_types.html
diff --git a/docs/sqlglot/optimizer/canonicalize.html b/docs/sqlglot/optimizer/canonicalize.html
diff --git a/docs/sqlglot/optimizer/eliminate_ctes.html b/docs/sqlglot/optimizer/eliminate_ctes.html
diff --git a/docs/sqlglot/optimizer/eliminate_joins.html b/docs/sqlglot/optimizer/eliminate_joins.html
diff --git a/docs/sqlglot/optimizer/eliminate_subqueries.html b/docs/sqlglot/optimizer/eliminate_subqueries.html
diff --git a/docs/sqlglot/optimizer/expand_multi_table_selects.html b/docs/sqlglot/optimizer/expand_multi_table_selects.html
diff --git a/docs/sqlglot/optimizer/isolate_table_selects.html b/docs/sqlglot/optimizer/isolate_table_selects.html
diff --git a/docs/sqlglot/optimizer/lower_identities.html b/docs/sqlglot/optimizer/lower_identities.html
diff --git a/docs/sqlglot/optimizer/merge_subqueries.html b/docs/sqlglot/optimizer/merge_subqueries.html
diff --git a/docs/sqlglot/optimizer/normalize.html b/docs/sqlglot/optimizer/normalize.html
diff --git a/docs/sqlglot/optimizer/optimize_joins.html b/docs/sqlglot/optimizer/optimize_joins.html
diff --git a/docs/sqlglot/optimizer/optimizer.html b/docs/sqlglot/optimizer/optimizer.html
diff --git a/docs/sqlglot/optimizer/pushdown_predicates.html b/docs/sqlglot/optimizer/pushdown_predicates.html
diff --git a/docs/sqlglot/optimizer/pushdown_projections.html b/docs/sqlglot/optimizer/pushdown_projections.html
diff --git a/docs/sqlglot/optimizer/qualify_columns.html b/docs/sqlglot/optimizer/qualify_columns.html
diff --git a/docs/sqlglot/optimizer/qualify_tables.html b/docs/sqlglot/optimizer/qualify_tables.html
diff --git a/docs/sqlglot/optimizer/scope.html b/docs/sqlglot/optimizer/scope.html
diff --git a/docs/sqlglot/optimizer/simplify.html b/docs/sqlglot/optimizer/simplify.html
diff --git a/docs/sqlglot/optimizer/unnest_subqueries.html b/docs/sqlglot/optimizer/unnest_subqueries.html
diff --git a/docs/sqlglot/parser.html b/docs/sqlglot/parser.html
diff --git a/docs/sqlglot/planner.html b/docs/sqlglot/planner.html
diff --git a/docs/sqlglot/schema.html b/docs/sqlglot/schema.html
diff --git a/docs/sqlglot/serde.html b/docs/sqlglot/serde.html
diff --git a/docs/sqlglot/time.html b/docs/sqlglot/time.html
diff --git a/docs/sqlglot/tokens.html b/docs/sqlglot/tokens.html
diff --git a/docs/sqlglot/transforms.html b/docs/sqlglot/transforms.html
diff --git a/docs/sqlglot/trie.html b/docs/sqlglot/trie.html