Add sphinx docs

.gitignore

@@ -51,8 +51,6 @@ unittests.cfg
 package-lock.json
 
 ./api/.env
-./api/gcp.json
-
 ./ui/.env
 
 # Created by https://www.toptal.com/developers/gitignore/api/python
@@ -244,4 +242,8 @@ airflow/include/data/astronomer/registry/registry_cells.parquet
 airflow/include/data/astronomer/registry/registry_dags.parquet
 airflow/include/data/baseline_data_*.parquet
 airflow/include/data/slack/troubleshooting.parquet
+
+
+# GCP
 api/gcp.json
+api/application_default_credentials.json

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/README.md

@@ -1,7 +1,7 @@
 <br />
 
 <p align="center">
-  <img src="static/logo.svg" />
+  <img src="_static/logo.svg" />
 </p>
 
 <br />
@@ -20,7 +20,7 @@ If you have any questions, feedback, or want to share similar use cases, reach o
 
 ## Data Retrieval & Embedding
 <p align="center">
-  <img src="static/ingestion.png" />
+  <img src="_static/ingestion.png" />
 </p>
 
 In order to make the responses as factual and accurate as possible, it's generally best practice to use [Retrieval Augmented Generation (RAG)](https://proceedings.neurips.cc/paper/2020/hash/6b493230205f780e1bc26945df7481e5-Abstract.html). However, in order for RAG to be effective, a vector database needs to be populated with the most up-to-date and relevant information.
@@ -45,7 +45,7 @@ See the [Ingest README](https://github.com/astronomer/ask-astro/tree/main/airflo
 
 ## Prompt Orchestration
 <p align="center">
-  <img src="static/prompt-orchestration.png" />
+  <img src="_static/prompt-orchestration.png" />
 </p>
 
 Ask Astro uses LangChain's `ConversationalRetrievalChain` to generate a response. This chain does the following:
@@ -60,7 +60,7 @@ This generally works well. For prompt rewording, we use `gpt-3.5-turbo`, which r
 
 ## Feedback Loops
 <p align="center">
-  <img src="static/feedback-loops.png" />
+  <img src="_static/feedback-loops.png" />
 </p>
 
 Airflow is critical in improving model performance over time. Feedback on answers come from two places:

docs/conf.py

@@ -0,0 +1,27 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "ask-astro"
+copyright = "2023, astronomer.io"  # noqa: A001
+author = "astronomer.io"
+release = "0.0.1"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+root_doc = "index"
+extensions = ["myst_parser"]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_book_theme"
+html_static_path = ["_static"]

docs/index.md

@@ -0,0 +1,25 @@
+```{include} README.md
+```
+
+```{toctree}
+:hidden:
+:caption: 💻 Develop UI
+
+ui/README.md
+```
+
+```{toctree}
+:hidden:
+:caption: 💻 Develop Backend Server
+
+api/cloudbuild_and_run.md
+api/google_firestore.md
+api/setup_slack_bot.md
+```
+
+```{toctree}
+:hidden:
+:caption: 💻 Develop Airflow DAGs
+
+airflow/README.md
+```

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+    set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+    echo.
+    echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+    echo.installed, then set the SPHINXBUILD environment variable to point
+    echo.to the full path of the 'sphinx-build' executable. Alternatively you
+    echo.may add the Sphinx directory to PATH.
+    echo.
+    echo.If you don't have Sphinx installed, grab it from
+    echo.https://www.sphinx-doc.org/
+    exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd