From e940a2e70aacbe93953f657e1af2b63d824f29d5 Mon Sep 17 00:00:00 2001 From: Jael Gu Date: Thu, 6 Apr 2023 22:45:04 +0800 Subject: [PATCH] Update foots (#127) Signed-off-by: Jael Gu --- docs/_templates/author.html | 1 + docs/_templates/copyright.html | 1 + docs/index.rst | 27 ++++++++++----------------- 3 files changed, 12 insertions(+), 17 deletions(-) create mode 100644 docs/_templates/author.html create mode 100644 docs/_templates/copyright.html diff --git a/docs/_templates/author.html b/docs/_templates/author.html new file mode 100644 index 00000000..00ffd11d --- /dev/null +++ b/docs/_templates/author.html @@ -0,0 +1 @@ +By Zilliz Inc. \ No newline at end of file diff --git a/docs/_templates/copyright.html b/docs/_templates/copyright.html new file mode 100644 index 00000000..99293c57 --- /dev/null +++ b/docs/_templates/copyright.html @@ -0,0 +1 @@ +

© Copyright 2023, Zilliz Inc.

\ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index aba9cc00..4c66da84 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -107,26 +107,19 @@ To use GPTCache exclusively, only the following lines of code are required, and More Docs: -- `Usage, how to use GPTCache better <./usage.md>`_ -- `Features, all features currently supported by the cache <./feature.md>`_ +- `Usage, how to use GPTCache better <./usage.html>`_ +- `Features, all features currently supported by the cache <./feature.html>`_ - `Examples, learn better custom caching `_ - -Usage ------ - -GPTCache is easy to understand and can boost your LLM API speed by 100x in just two steps: - -1. Build your cache, which includes deciding on embedding functions, similarity evaluation functions, where to store the data, and eviction configurations. -2. Choose your adapter. GPTCache currently supports the OpenAI chatGPT interface and langchain interface. Langchain supports a variety of LLMs, such as Anthropic, Llama-cpp, Huggingface hub, and Cohere. - .. toctree:: - :maxdepth: 2 - :caption: Usage - :name: usage + :maxdepth: 1 + :caption: Getting Started + :name: getting-started :hidden: - usage + usage.md + feature.md + Modules @@ -189,7 +182,7 @@ Contributing WWe are extremely open to contributions, be it through new features, enhanced infrastructure, or improved documentation. -For comprehensive instructions on how to contribute, please refer to our `contribution guide `_. +For comprehensive instructions on how to contribute, please refer to our `contribution guide `_. .. toctree:: :maxdepth: 1 @@ -197,4 +190,4 @@ For comprehensive instructions on how to contribute, please refer to our `contri :name: contributing :hidden: - contributing + contributing.md