phoenix-oss/llama-stack-mirror
0
0
Fork 1
mirror of https://github.com/meta-llama/llama-stack.git synced 2025-08-15 14:08:00 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Update blocks formatting in docs/source files (#3120)

Browse source 
**Description:** 
The standard markdown [!NOTE] format is not supported on Sphinx
generated documentation, replacing those instances. Also updating other
Notes, Tips and Warning blocks throughout the source docs

WIP: Working to update the provider code gen
This commit is contained in:
Kelly Brown 2025-08-13 11:06:31 -04:00 • committed by GitHub
parent c9b78602d3
commit 0cbd93c5cc
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 24 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

4
scripts/provider_codegen.py
View file

@ -187,7 +187,7 @@ def generate_provider_docs(provider_spec: Any, api_name: str) -> str:
if config_info.get("accepts_extra_config"):
md_lines.append(
"> **Note**: This configuration class accepts additional fields beyond those listed above. You can pass any additional configuration options that will be forwarded to the underlying provider."
"```{note}\n This configuration class accepts additional fields beyond those listed above. You can pass any additional configuration options that will be forwarded to the underlying provider.\n ```\n"
)
md_lines.append("")
@ -232,7 +232,7 @@ def generate_provider_docs(provider_spec: Any, api_name: str) -> str:
if hasattr(provider_spec, "deprecation_warning") and provider_spec.deprecation_warning:
md_lines.append("## Deprecation Notice")
md_lines.append("")
md_lines.append(f"⚠️ **Warning**: {provider_spec.deprecation_warning}")
md_lines.append(f"```{{warning}}\n{provider_spec.deprecation_warning}\n```")
md_lines.append("")
if hasattr(provider_spec, "deprecation_error") and provider_spec.deprecation_error: