diff --git a/.gitignore b/.gitignore index 5ed52fc7b..ac0bfc93f 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,13 @@ __pycache__/ # C extensions *.so +# Ignore the build directory for Sphinx documentation +docs/_build/ +C:\Users\User\contribute-hamilton\hamilton\docs\_build + +env1/ +.venv/ + # Distribution / packaging .Python build/ diff --git a/docs/integrations/fastapi.md b/docs/cookbook/fastapi.md similarity index 99% rename from docs/integrations/fastapi.md rename to docs/cookbook/fastapi.md index 937c2a908..94b72f37b 100644 --- a/docs/integrations/fastapi.md +++ b/docs/cookbook/fastapi.md @@ -150,7 +150,7 @@ app.routes[-1].description += f""" 📞 If you are interested in a generic approach to add visualizations to all of your endpoints, please reach out to us on [Slack](https://join.slack.com/t/hamilton-opensource/shared_invite/zt-2niepkra8-DGKGf_tTYhXuJWBTXtIs4g)! -![FastAPI Swagger](./fastapi_docs.png) +![FastAPI Swagger](fastapi_docs.png) ### Benefits - **Separation of concerns**: the decoupling between `server.py` and `summarization.py` makes it easier to extend and test the server separately from the data transformations. diff --git a/docs/integrations/fastapi_docs.png b/docs/cookbook/fastapi_docs.png similarity index 100% rename from docs/integrations/fastapi_docs.png rename to docs/cookbook/fastapi_docs.png diff --git a/docs/integrations/fastapi_summarization.png b/docs/cookbook/fastapi_summarization.png similarity index 100% rename from docs/integrations/fastapi_summarization.png rename to docs/cookbook/fastapi_summarization.png diff --git a/docs/integrations/streamlit.md b/docs/cookbook/streamlit.md similarity index 99% rename from docs/integrations/streamlit.md rename to docs/cookbook/streamlit.md index ef9c68fc2..e7127aed4 100644 --- a/docs/integrations/streamlit.md +++ b/docs/cookbook/streamlit.md @@ -113,7 +113,7 @@ def job_hist(job_df: pd.DataFrame) -> Figure: return px.histogram(job_df["balance"]) ``` -![logic dataflow](./streamlit_logic.png) +![logic dataflow](streamlit_logic.png) Then, the Streamlit UI is defined in `app.py`. Notice a few things: - `app.py` doesn't have to depend on `pandas` and `plotly`. diff --git a/docs/integrations/streamlit_logic.png b/docs/cookbook/streamlit_logic.png similarity index 100% rename from docs/integrations/streamlit_logic.png rename to docs/cookbook/streamlit_logic.png diff --git a/docs/integrations/index.rst b/docs/integrations/index.rst index 4f0e3ab61..f2be9f5e1 100644 --- a/docs/integrations/index.rst +++ b/docs/integrations/index.rst @@ -1,30 +1,55 @@ -============ -Integrations -============ +============= +Documentation +============= -This section showcases how Hamilton integrates with popular frameworks. +This section showcases how Hamilton integrates with various tools and frameworks. + +Plugins +======= + +This section highlights the plugins and libraries that Hamilton has extensions for. + +.. toctree:: + :maxdepth: 2 + :caption: Plugins: + + plugins/dlt/index + plugins/ibis/index + plugins/dbt + +Cookbook +======== + +This section provides practical examples of how to use Hamilton with various tools. + +.. toctree:: + :maxdepth: 2 + :caption: Cookbook: + + cookbook/fastapi + cookbook/streamlit + +Other Integrations +================== + +This section lists other Hamilton integrations available for various platforms and services. .. toctree:: - dlt/index - fastapi - ibis/index - streamlit - dbt - MLFlow - Airflow - Amazon Web Services - Burr - Dagster - Dask - Feast - Metaflow - Pandera - Plotly - Polars - Prefect - Ray - Slack - Spark - Vaex - Narwhals - OpenLineage + MLFlow + Airflow + Amazon Web Services + Burr + Dagster + Dask + Feast + Metaflow + Pandera + Plotly + Polars + Prefect + Ray + Slack + Spark + Vaex + Narwhals + OpenLineage diff --git a/docs/integrations/dbt.rst b/docs/plugins/dbt.rst similarity index 100% rename from docs/integrations/dbt.rst rename to docs/plugins/dbt.rst diff --git a/docs/integrations/dlt/index.md b/docs/plugins/dlt/index.md similarity index 100% rename from docs/integrations/dlt/index.md rename to docs/plugins/dlt/index.md diff --git a/docs/integrations/dlt/materialization.png b/docs/plugins/dlt/materialization.png similarity index 100% rename from docs/integrations/dlt/materialization.png rename to docs/plugins/dlt/materialization.png diff --git a/docs/integrations/dlt/transform.png b/docs/plugins/dlt/transform.png similarity index 100% rename from docs/integrations/dlt/transform.png rename to docs/plugins/dlt/transform.png diff --git a/docs/integrations/ibis/ibis_column.png b/docs/plugins/ibis/ibis_column.png similarity index 100% rename from docs/integrations/ibis/ibis_column.png rename to docs/plugins/ibis/ibis_column.png diff --git a/docs/integrations/ibis/ibis_config.png b/docs/plugins/ibis/ibis_config.png similarity index 100% rename from docs/integrations/ibis/ibis_config.png rename to docs/plugins/ibis/ibis_config.png diff --git a/docs/integrations/ibis/ibis_plan.png b/docs/plugins/ibis/ibis_plan.png similarity index 100% rename from docs/integrations/ibis/ibis_plan.png rename to docs/plugins/ibis/ibis_plan.png diff --git a/docs/integrations/ibis/ibis_table.png b/docs/plugins/ibis/ibis_table.png similarity index 100% rename from docs/integrations/ibis/ibis_table.png rename to docs/plugins/ibis/ibis_table.png diff --git a/docs/integrations/ibis/ibis_udf.png b/docs/plugins/ibis/ibis_udf.png similarity index 100% rename from docs/integrations/ibis/ibis_udf.png rename to docs/plugins/ibis/ibis_udf.png diff --git a/docs/integrations/ibis/index.md b/docs/plugins/ibis/index.md similarity index 100% rename from docs/integrations/ibis/index.md rename to docs/plugins/ibis/index.md