diff --git a/.github/workflows/release-docs.yml b/.github/workflows/release-docs.yml index bca6df5ca..d84cbce62 100644 --- a/.github/workflows/release-docs.yml +++ b/.github/workflows/release-docs.yml @@ -10,7 +10,7 @@ on: workflow_dispatch: concurrency: - group: execute-notebook-${{ github.ref }} + group: release-docs-${{ github.ref }} cancel-in-progress: true jobs: diff --git a/docs/backend/native_api.ipynb b/docs/backend/native_api.ipynb index bbf9be9e9..775917c00 100644 --- a/docs/backend/native_api.ipynb +++ b/docs/backend/native_api.ipynb @@ -54,7 +54,7 @@ "metadata": {}, "source": [ "## Generate\n", - "Generate completions. This is similar to the `/v1/completions` in OpenAI API. Detailed parameters can be found in the [sampling parameters](https://sgl-project.github.io/references/sampling_params.html)." + "Generate completions. This is similar to the `/v1/completions` in OpenAI API. Detailed parameters can be found in the [sampling parameters](../references/sampling_params.html)." ] }, { @@ -254,8 +254,8 @@ "source": [ "## Encode\n", "\n", - "Encode text into embeddings. Note that this API is only available for [embedding models](./openai_embedding_api.ipynb) and will raise an error for generation models.\n", - "Therefore, we launch a new server to server an embedding model.\n" + "Encode text into embeddings. Note that this API is only available for [embedding models](openai_api_embeddings.html#openai-apis-embedding) and will raise an error for generation models.\n", + "Therefore, we launch a new server to server an embedding model." ] }, { diff --git a/docs/conf.py b/docs/conf.py index 5bad02038..f4d60f4dc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -28,10 +28,60 @@ extensions = [ "sphinxcontrib.mermaid", "nbsphinx", "sphinx.ext.mathjax", - "sphinx.ext.autodoc", ] +nbsphinx_allow_errors = True +nbsphinx_execute = 'never' + autosectionlabel_prefix_document = True +nbsphinx_allow_directives = True + + +myst_enable_extensions = [ + "dollarmath", + "amsmath", + "deflist", + "colon_fence", + "html_image", + "linkify", + "substitution", +] + +myst_heading_anchors = 3 + +nbsphinx_kernel_name = 'python3' +nbsphinx_execute_arguments = [ + "--InlineBackend.figure_formats={'svg', 'pdf'}", + "--InlineBackend.rc={'figure.dpi': 96}", +] + + +nb_render_priority = { + "html": ( + "application/vnd.jupyter.widget-view+json", + "application/javascript", + "text/html", + "image/svg+xml", + "image/png", + "image/jpeg", + "text/markdown", + "text/latex", + "text/plain", + ) +} + +myst_enable_extensions = [ + "dollarmath", + "amsmath", + "deflist", + "colon_fence", + "html_image", + "linkify", + "substitution", +] + +myst_heading_anchors = 3 +myst_ref_domains = ["std", "py"] templates_path = ["_templates"] diff --git a/docs/start/send_request.ipynb b/docs/start/send_request.ipynb index 0b5c05972..2323368ee 100644 --- a/docs/start/send_request.ipynb +++ b/docs/start/send_request.ipynb @@ -20,7 +20,7 @@ "--port 30000 --host 0.0.0.0\n", "```\n", "\n", - "in your terminal and wait for the server to be ready. Once the server is running, you can send test requests using curl or requests. The server implements the [OpenAI-compatible API](https://platform.openai.com/docs/api-reference/chat)." + "in your terminal and wait for the server to be ready. Once the server is running, you can send test requests using curl or requests. The server implements the [OpenAI-compatible APIs](https://platform.openai.com/docs/api-reference/chat)." ] }, {