forked from phoenix-oss/llama-stack-mirror
Fix broken links with docs
This commit is contained in:
parent
36938b716c
commit
0481fa9540
7 changed files with 63 additions and 13 deletions
|
@ -12,6 +12,8 @@
|
|||
# -- Project information -----------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
||||
|
||||
from docutils import nodes
|
||||
|
||||
project = "llama-stack"
|
||||
copyright = "2024, Meta"
|
||||
author = "Meta"
|
||||
|
@ -59,6 +61,10 @@ myst_enable_extensions = [
|
|||
"tasklist",
|
||||
]
|
||||
|
||||
myst_substitutions = {
|
||||
"docker_hub": "https://hub.docker.com/repository/docker/llamastack",
|
||||
}
|
||||
|
||||
# Copy button settings
|
||||
copybutton_prompt_text = "$ " # for bash prompts
|
||||
copybutton_prompt_is_regexp = True
|
||||
|
@ -98,3 +104,26 @@ redoc = [
|
|||
]
|
||||
|
||||
redoc_uri = "https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"
|
||||
|
||||
|
||||
def setup(app):
|
||||
def dockerhub_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
|
||||
url = f"https://hub.docker.com/r/llamastack/{text}"
|
||||
node = nodes.reference(rawtext, text, refuri=url, **options)
|
||||
return [node], []
|
||||
|
||||
def repopath_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
|
||||
parts = text.split("::")
|
||||
if len(parts) == 2:
|
||||
link_text = parts[0]
|
||||
url_path = parts[1]
|
||||
else:
|
||||
link_text = text
|
||||
url_path = text
|
||||
|
||||
url = f"https://github.com/meta-llama/llama-stack/tree/main/{url_path}"
|
||||
node = nodes.reference(rawtext, link_text, refuri=url, **options)
|
||||
return [node], []
|
||||
|
||||
app.add_role("dockerhub", dockerhub_role)
|
||||
app.add_role("repopath", repopath_role)
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue