add public and update docs

Makefile

@@ -29,3 +29,9 @@ stubs:
 	stubgen sqlframe/bigquery/functions.py --output ./ --inspect-mode
 	stubgen sqlframe/duckdb/functions.py --output ./ --inspect-mode
 	stubgen sqlframe/postgres/functions.py --output ./ --inspect-mode
+
+package:
+	pip3 install wheel && python3 setup.py sdist bdist_wheel
+
+publish: package
+	pip3 install twine && python3 -m twine upload dist/*

README.md

@@ -8,7 +8,7 @@ SQLFrame implements the PySpark DataFrame API in order to enable running transfo
 
 ![SQLFrame Diagram](docs/images/sqlframe_diagram.png)
 
-SQLFrame currently supports the following engines:
+SQLFrame currently supports the following engines (many more in development):
 
 * [BigQuery](docs/bigquery.md)
 * [DuckDB](docs/duckdb.md)
@@ -72,9 +72,7 @@ df = (
 )
 ```
 ```python
-df.sql()
-```
-```sql
+>>> df.sql()
 WITH `t94228` AS (
   SELECT
     `natality`.`year` AS `year`,
@@ -101,9 +99,7 @@ ORDER BY
 LIMIT 5
 ```
 ```python
-df.show()
-```
-```
+>>> df.show()
 +------+-------------------------------------+----------------+
 | year | number of new families single child | percent change |
 +------+-------------------------------------+----------------+

mkdocs.yml

@@ -32,6 +32,8 @@ theme:
     - navigation.tracking
     - navigation.tabs
     - navigation.sections
+    - toc.integrate
+    - toc.follow
 plugins:
   - include-markdown
   - search