Feature: linkcheck-action (#534) (#542)

- Add support for local build and linkchecking of docs
- Add GitHub Action to automatically check links before prior to
publication
- Minor reformat of Contributing readme
- Fix existing broken links

Co-authored-by: Hunter Gerlach <hunter@huntergerlach.com>

Co-authored-by: Hunter Gerlach <HunterGerlach@users.noreply.github.com>
Co-authored-by: Hunter Gerlach <hunter@huntergerlach.com>
This commit is contained in:
Harrison Chase
2023-01-04 21:39:50 -08:00
committed by GitHub
parent 5aefc2b7ce
commit 9753bccc71
32 changed files with 865 additions and 220 deletions

View File

@@ -3,11 +3,11 @@ Generic Functionality
The examples here all address certain "how-to" guides for working with LLMs.
`LLM Serialization <examples/llm_serialization.html>`_: A walkthrough of how to serialize LLMs to and from disk.
`LLM Serialization <./examples/llm_serialization.html>`_: A walkthrough of how to serialize LLMs to and from disk.
`LLM Caching <examples/llm_caching.html>`_: Covers different types of caches, and how to use a cache to save results of LLM calls.
`LLM Caching <./examples/llm_caching.html>`_: Covers different types of caches, and how to use a cache to save results of LLM calls.
`Custom LLM <examples/custom_llm.html>`_: How to create and use a custom LLM class, in case you have an LLM not from one of the standard providers (including one that you host yourself).
`Custom LLM <./examples/custom_llm.html>`_: How to create and use a custom LLM class, in case you have an LLM not from one of the standard providers (including one that you host yourself).
.. toctree::
@@ -17,4 +17,4 @@ The examples here all address certain "how-to" guides for working with LLMs.
:name: Generic Functionality
:hidden:
examples/*
./examples/*

View File

@@ -5,13 +5,13 @@ The examples here all address certain "how-to" guides for working with LLMs.
They are split into two categories:
1. `Generic Functionality <generic_how_to.html>`_: Covering generic functionality all LLMs should have.
2. `Integrations <integrations.html>`_: Covering integrations with various LLM providers.
1. `Generic Functionality <./generic_how_to.html>`_: Covering generic functionality all LLMs should have.
2. `Integrations <./integrations.html>`_: Covering integrations with various LLM providers.
.. toctree::
:maxdepth: 1
:glob:
:hidden:
generic_how_to.rst
integrations.rst
./generic_how_to.rst
./integrations.rst

View File

@@ -3,11 +3,11 @@ Integrations
The examples here are all "how-to" guides for how to integrate with various LLM providers.
`Huggingface Hub <examples/huggingface_hub.html>`_: Covers how to connect to LLMs hosted on HuggingFace Hub.
`Huggingface Hub <./integrations/huggingface_hub.html>`_: Covers how to connect to LLMs hosted on HuggingFace Hub.
`Azure OpenAI <examples/azure_openai_example.html>`_: Covers how to connect to Azure-hosted OpenAI Models.
`Azure OpenAI <./integrations/azure_openai_example.html>`_: Covers how to connect to Azure-hosted OpenAI Models.
`Manifest <examples/manifest.html>`_: Covers how to utilize the Manifest wrapper.
`Manifest <./integrations/manifest.html>`_: Covers how to utilize the Manifest wrapper.
.. toctree::
@@ -17,4 +17,4 @@ The examples here are all "how-to" guides for how to integrate with various LLM
:name: Specific LLM Integrations
:hidden:
integrations/*
./integrations/*