Refactor documentation structure for issue #1043

.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/

docs/integrations/fastapi.md → docs/cookbook/fastapi.md

@@ -150,7 +150,7 @@ app.routes[-1].description += f"""<img src="data:image/png;base64,{base64_viz}"/
 ```
 > 📞 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.

docs/integrations/streamlit.md → 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`.

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 <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/mlflow>
-    Airflow <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/airflow>
-    Amazon Web Services <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/aws>
-    Burr <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/LLM_Workflows/image_telephone>
-    Dagster <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/dagster>
-    Dask <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/dask>
-    Feast <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/feast>
-    Metaflow <https://github.com/outerbounds/hamilton-metaflow>
-    Pandera <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/data_quality/pandera>
-    Plotly <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/plotly>
-    Polars <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/polars>
-    Prefect <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/prefect>
-    Ray <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/ray>
-    Slack <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/slack>
-    Spark <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/spark>
-    Vaex <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/vaex>
-    Narwhals <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/narwhals>
-    OpenLineage <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/openlineage>
+   MLFlow <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/mlflow>
+   Airflow <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/airflow>
+   Amazon Web Services <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/aws>
+   Burr <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/LLM_Workflows/image_telephone>
+   Dagster <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/dagster>
+   Dask <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/dask>
+   Feast <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/feast>
+   Metaflow <https://github.com/outerbounds/hamilton-metaflow>
+   Pandera <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/data_quality/pandera>
+   Plotly <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/plotly>
+   Polars <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/polars>
+   Prefect <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/prefect>
+   Ray <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/ray>
+   Slack <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/slack>
+   Spark <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/spark>
+   Vaex <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/vaex>
+   Narwhals <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/narwhals>
+   OpenLineage <https://github.com/DAGWorks-Inc/hamilton/tree/main/examples/openlineage>