Skip to content

Commit fb12879

Browse files
authored
[docs][App] Include components in the API reference (#16414)
1 parent ecd2791 commit fb12879

File tree

4 files changed

+12
-117
lines changed

4 files changed

+12
-117
lines changed

.gitignore

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,6 @@ src/lightning_app/ui/*
166166
hars*
167167
artifacts/*
168168
*docs/examples*
169-
*docs/source-app/api*
170169

171170
# tutorials
172171
our_model.tar

docs/source-app/api_reference/components.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,18 @@ ___________________
1818
:nosignatures:
1919
:template: classtemplate.rst
2020

21+
~database.client.DatabaseClient
22+
~database.server.Database
2123
~python.popen.PopenPythonScript
2224
~python.tracer.TracerPythonScript
2325
~training.LightningTrainerScript
2426
~serve.gradio_server.ServeGradio
2527
~serve.serve.ModelInferenceAPI
28+
~serve.python_server.PythonServer
29+
~serve.streamlit.ServeStreamlit
30+
~multi_node.base.MultiNode
31+
~multi_node.lite.LiteMultiNode
32+
~multi_node.pytorch_spawn.PyTorchSpawnMultiNode
33+
~multi_node.trainer.LightningTrainerMultiNode
34+
~serve.auto_scaler.AutoScaler
35+
~serve.auto_scaler.ColdStartProxy

docs/source-app/api_reference/frontend.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,3 +21,5 @@ ___________________
2121
~web.StaticWebFrontend
2222
~stream_lit.StreamlitFrontend
2323
~panel.PanelFrontend
24+
25+
Learn more about :ref:`Frontend's <ui_and_frontends>`.

docs/source-app/api_references.rst

Lines changed: 0 additions & 116 deletions
This file was deleted.

0 commit comments

Comments
 (0)