forked from phoenix-oss/llama-stack-mirror
[docs] add openapi spec to docs (#508)
# What does this PR do? - modify openapi generator to add coming soon tag for unimplemented api - sphinx-redocs extension for openapi spec to readthedocs page ## Test Plan https://github.com/user-attachments/assets/b4c7eebc-2361-4198-a987-dbfbcff914cf ## Before submitting - [ ] This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case). - [ ] Ran pre-commit to handle lint / formatting issues. - [ ] Read the [contributor guideline](https://github.com/meta-llama/llama-stack/blob/main/CONTRIBUTING.md), Pull Request section? - [ ] Updated relevant documentation. - [ ] Wrote necessary unit or integration tests.
This commit is contained in:
parent
1b2b32f959
commit
d97cfaa9d9
8 changed files with 80 additions and 44 deletions
7
docs/source/references/api_reference/index.md
Normal file
7
docs/source/references/api_reference/index.md
Normal file
|
@ -0,0 +1,7 @@
|
|||
# API Reference
|
||||
|
||||
```{eval-rst}
|
||||
.. sphinxcontrib-redoc:: ../resources/llama-stack-spec.yaml
|
||||
:page-title: API Reference
|
||||
:expand-responses: all
|
||||
```
|
|
@ -1,11 +1,15 @@
|
|||
# References
|
||||
|
||||
- [API Reference](api_reference/index) for the Llama Stack API specification
|
||||
- [Llama CLI](llama_cli_reference/index) for building and running your Llama Stack server
|
||||
- [Llama Stack Client CLI](llama_stack_client_cli_reference/index) for interacting with your Llama Stack server
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 2
|
||||
:hidden:
|
||||
|
||||
api_reference/index
|
||||
llama_cli_reference/index
|
||||
llama_stack_client_cli_reference/index
|
||||
llama_cli_reference/download_models
|
||||
```
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue