[tentative] revert embedding nb's in docs (run-llama#1208)

MaxJPRey · Apr 16, 2023 · 6752044 · 6752044
1 parent 8d279d4
commit 6752044
Show file tree

Hide file tree

Showing 126 changed files with 8,630 additions and 9,103 deletions.
diff --git a/.github/workflows/dev_docs.yml b/.github/workflows/dev_docs.yml
@@ -10,11 +10,9 @@ jobs:
     steps:
       - uses: actions/checkout@v2
       - uses: cpina/github-action-push-to-another-repository@main
-      - uses: awalsh128/cache-apt-pkgs-action@latest
         env:
           API_TOKEN_GITHUB: ${{ secrets.PAT}}
         with:
-          packages: pandoc
           source-directory: './docs'
           destination-github-username: 'avb-is-me'
           destination-repository-name: 'gpt_index'

diff --git a/.gitignore b/.gitignore
@@ -82,6 +82,7 @@ target/
 
 # Jupyter Notebook
 .ipynb_checkpoints
+notebooks/
 
 # IPython
 profile_default/

diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -1,19 +1,12 @@
 version: 2
-
-formats:
-  - htmlzip
-  - epub
-
-search:
-  ranking:
-    '*': 1
-    getting_started/*: 2
-    guides/*: 2
-    how_to/*: 2
-    use_cases/*: 2
-    gallery/*: 2
-    reference/*: 1
-    index.html*: 2
-
-conda:
-  environment: docs/readthedocs-environment.yml
+sphinx:
+  configuration: docs/conf.py
+build:
+  image: testing
+formats: all
+python:
+  version: 3.9
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .
diff --git a/docs/build_notebooks.py b/docs/build_notebooks.py
diff --git a/docs/conf.py b/docs/conf.py
@@ -37,8 +37,6 @@
     "sphinx_rtd_theme",
     "sphinx.ext.mathjax",
     "myst_parser",
-    "nbsphinx",
-    "nbsphinx_link",
 ]
 
 myst_heading_anchors = 4
@@ -57,8 +55,6 @@
 html_title = "LlamaIndex"
 html_static_path = ["_static"]
 
-# nbsphinx options
-nbsphinx_execute = "never"
 html_css_files = [
     "css/custom.css",
 ]

diff --git a/docs/guides/notebooks.rst b/docs/guides/notebooks.rst
@@ -3,173 +3,4 @@ Notebooks
 
 We offer a wide variety of example notebooks. They are referenced throughout the documentation.
 
-All examples can be accessed using the menu links or can be found `directly in the repository`_.
-
-.. _directly in the repository: https://github.com/jerryjliu/llama_index/tree/main/examples
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Async
-
-  ./notebooks/async/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Azure
-
-  notebooks/azure_demo/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Chatbot
-
-  notebooks/chatbot/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: ChatGPT Plugin
-
-  notebooks/chatgpt_plugin/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Composable Indices
-
-  notebooks/composable_indices/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Cost Analysis
-
-  notebooks/cost_analysis/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Data Connectors
-
-  notebooks/data_connectors/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Docstore
-
-  notebooks/docstore/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Evaluation
-
-  notebooks/evaluation/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Gastby
-
-  notebooks/gatsby/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Knowledge Graph
-
-  notebooks/knowledge_graph/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Langchain Integration
-
-  notebooks/langchain_demo/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Multimodal
-
-  notebooks/multimodal/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Node Post-Processor
-
-  notebooks/node_postprocessor/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Optimizer
-
-  notebooks/optimizer/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Paul Graham Essay
-
-  notebooks/paul_graham_essay/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Playground
-
-  notebooks/playground/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Query Transformations
-
-  notebooks/query_transformations/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Structured Indices
-
-  notebooks/struct_indices/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Wikipedia
-
-  notebooks/test_wiki/*
-
-
-.. toctree::
-  :glob:
-  :maxdepth: 1
-  :caption: Vector Indices
-
-  notebooks/vector_indices/*
+Example notebooks are found `here <https://github.com/jerryjliu/gpt_index/tree/main/examples>`_.
diff --git a/docs/guides/notebooks/async/AsyncComposableIndicesSEC.nblink b/docs/guides/notebooks/async/AsyncComposableIndicesSEC.nblink
diff --git a/docs/guides/notebooks/async/AsyncGPTTreeIndexDemo.nblink b/docs/guides/notebooks/async/AsyncGPTTreeIndexDemo.nblink
diff --git a/docs/guides/notebooks/async/AsyncLLMPredictorDemo.nblink b/docs/guides/notebooks/async/AsyncLLMPredictorDemo.nblink
diff --git a/docs/guides/notebooks/async/AsyncQueryDemo.nblink b/docs/guides/notebooks/async/AsyncQueryDemo.nblink
diff --git a/docs/guides/notebooks/azure_demo/AzureOpenAI.nblink b/docs/guides/notebooks/azure_demo/AzureOpenAI.nblink
diff --git a/docs/guides/notebooks/chatbot/Chatbot_SEC.nblink b/docs/guides/notebooks/chatbot/Chatbot_SEC.nblink
diff --git a/docs/guides/notebooks/chatgpt_plugin/ChatGPTRetrievalPluginIndexDemo.nblink b/docs/guides/notebooks/chatgpt_plugin/ChatGPTRetrievalPluginIndexDemo.nblink
diff --git a/docs/guides/notebooks/chatgpt_plugin/ChatGPTRetrievalPluginReaderDemo.nblink b/docs/guides/notebooks/chatgpt_plugin/ChatGPTRetrievalPluginReaderDemo.nblink
diff --git a/docs/guides/notebooks/chatgpt_plugin/ChatGPT_Retrieval_Plugin_Upload.nblink b/docs/guides/notebooks/chatgpt_plugin/ChatGPT_Retrieval_Plugin_Upload.nblink
diff --git a/docs/guides/notebooks/composable_indices/City_Analysis-Decompose-KeywordTable.nblink b/docs/guides/notebooks/composable_indices/City_Analysis-Decompose-KeywordTable.nblink
diff --git a/docs/guides/notebooks/composable_indices/ComposableIndices-Prior.nblink b/docs/guides/notebooks/composable_indices/ComposableIndices-Prior.nblink
diff --git a/docs/guides/notebooks/composable_indices/ComposableIndices-Weaviate.nblink b/docs/guides/notebooks/composable_indices/ComposableIndices-Weaviate.nblink
diff --git a/docs/guides/notebooks/composable_indices/ComposableIndices.nblink b/docs/guides/notebooks/composable_indices/ComposableIndices.nblink
diff --git a/docs/guides/notebooks/composable_indices/QASummaryGraph.nblink b/docs/guides/notebooks/composable_indices/QASummaryGraph.nblink
diff --git a/docs/guides/notebooks/cost_analysis/TokenPredictor.nblink b/docs/guides/notebooks/cost_analysis/TokenPredictor.nblink
diff --git a/docs/guides/notebooks/data_connectors/ChromaDemo.nblink b/docs/guides/notebooks/data_connectors/ChromaDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/DatabaseReaderDemo.nblink b/docs/guides/notebooks/data_connectors/DatabaseReaderDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/DiscordDemo.nblink b/docs/guides/notebooks/data_connectors/DiscordDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/FaissDemo.nblink b/docs/guides/notebooks/data_connectors/FaissDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/GithubRepositoryReaderDemo.nblink b/docs/guides/notebooks/data_connectors/GithubRepositoryReaderDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/GoogleDocsDemo.nblink b/docs/guides/notebooks/data_connectors/GoogleDocsDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/MakeDemo.nblink b/docs/guides/notebooks/data_connectors/MakeDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/MboxReaderDemo.nblink b/docs/guides/notebooks/data_connectors/MboxReaderDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/MilvusReaderDemo.nblink b/docs/guides/notebooks/data_connectors/MilvusReaderDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/MongoDemo.nblink b/docs/guides/notebooks/data_connectors/MongoDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/NotionDemo.nblink b/docs/guides/notebooks/data_connectors/NotionDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/ObsidianReaderDemo.nblink b/docs/guides/notebooks/data_connectors/ObsidianReaderDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/PineconeDemo.nblink b/docs/guides/notebooks/data_connectors/PineconeDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/QdrantDemo.nblink b/docs/guides/notebooks/data_connectors/QdrantDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/SlackDemo.nblink b/docs/guides/notebooks/data_connectors/SlackDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/TwitterDemo.nblink b/docs/guides/notebooks/data_connectors/TwitterDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/WeaviateDemo.nblink b/docs/guides/notebooks/data_connectors/WeaviateDemo.nblink
diff --git a/docs/guides/notebooks/data_connectors/WebPageDemo.nblink b/docs/guides/notebooks/data_connectors/WebPageDemo.nblink
diff --git a/docs/guides/notebooks/docstore/DocstoreDemo.nblink b/docs/guides/notebooks/docstore/DocstoreDemo.nblink
diff --git a/docs/guides/notebooks/evaluation/GuardrailsDemo.nblink b/docs/guides/notebooks/evaluation/GuardrailsDemo.nblink
diff --git a/docs/guides/notebooks/evaluation/LangchainOutputParserDemo.nblink b/docs/guides/notebooks/evaluation/LangchainOutputParserDemo.nblink
diff --git a/docs/guides/notebooks/evaluation/TestNYC-Evaluation-Query.nblink b/docs/guides/notebooks/evaluation/TestNYC-Evaluation-Query.nblink
diff --git a/docs/guides/notebooks/evaluation/TestNYC-Evaluation.nblink b/docs/guides/notebooks/evaluation/TestNYC-Evaluation.nblink
diff --git a/docs/guides/notebooks/gatsby/TestGatsby.nblink b/docs/guides/notebooks/gatsby/TestGatsby.nblink
diff --git a/docs/guides/notebooks/knowledge_graph/KnowledgeGraphDemo.nblink b/docs/guides/notebooks/knowledge_graph/KnowledgeGraphDemo.nblink
diff --git a/docs/guides/notebooks/langchain_demo/LangchainDemo.nblink b/docs/guides/notebooks/langchain_demo/LangchainDemo.nblink
diff --git a/docs/guides/notebooks/multimodal/Multimodal.nblink b/docs/guides/notebooks/multimodal/Multimodal.nblink