diff --git a/docs/source-app/core_api/lightning_app/communication.rst b/docs/source-app/core_api/lightning_app/communication.rst index 9a823b0844..d1aa1d35f5 100644 --- a/docs/source-app/core_api/lightning_app/communication.rst +++ b/docs/source-app/core_api/lightning_app/communication.rst @@ -8,7 +8,7 @@ Communication between Lightning Components **Level:** Intermediate -**Prerequisite**: Read the `Communication in Lightning Apps article <../../access_app_state.html>`_. +**Prerequisite**: Read the :doc:`Communication in Lightning Apps article <../../../workflows/access_app_state>`. ---- diff --git a/docs/source-app/core_api/lightning_work/payload.rst b/docs/source-app/core_api/lightning_work/payload.rst index b23bf7ca32..cde42af1bd 100644 --- a/docs/source-app/core_api/lightning_work/payload.rst +++ b/docs/source-app/core_api/lightning_work/payload.rst @@ -8,7 +8,7 @@ Sharing Objects between LightningWorks **Level:** Advanced -**Prerequisite**: Reach Level 16+, know about the `pandas DataFrames `_ and read and read the `Access app state guide <../../access_app_state.html>`_. +**Prerequisite**: Reach Level 16+, know about the `pandas DataFrames `_ and read and read the :doc:`Access app state guide <../../workflows/access_app_state>`. ---- diff --git a/docs/source-app/examples/dag/dag_from_scratch.rst b/docs/source-app/examples/dag/dag_from_scratch.rst index ac843ab25d..423cf633de 100644 --- a/docs/source-app/examples/dag/dag_from_scratch.rst +++ b/docs/source-app/examples/dag/dag_from_scratch.rst @@ -15,7 +15,7 @@ In this example, you will learn how to create a simple DAG which: and learn how to schedule this entire process. -Find the complete example `here `_. +Find the complete example `here `_. ---- diff --git a/docs/source-app/glossary/dag.rst b/docs/source-app/glossary/dag.rst index ef85d33cf3..9578b1e526 100644 --- a/docs/source-app/glossary/dag.rst +++ b/docs/source-app/glossary/dag.rst @@ -19,7 +19,7 @@ Can I Build a DAG with Lightning? ********************************* Yes! -DAGs are one of the easiest Lightning Apps to build. For example, here's a `full app that defines a DAG <../examples/dag/dag.html>`_. +DAGs are one of the easiest Lightning Apps to build. For example, here's a :doc:`full app that defines a DAG <../examples/dag/dag>`. ---- diff --git a/docs/source-app/glossary/storage/drive_content.rst b/docs/source-app/glossary/storage/drive_content.rst index 8ab7015fd7..ff1540e8ce 100644 --- a/docs/source-app/glossary/storage/drive_content.rst +++ b/docs/source-app/glossary/storage/drive_content.rst @@ -4,7 +4,7 @@ What are Lightning Drives? ************************** -Lightning Drives are shared app storage that allow you to share files between `LightningWork (Work) <../../core_api/lightning_work/index.html>`_ components, so that you distributed components can share files when running on the cloud. Using drives, you can run your Lightning App both locally and in the cloud without changing the code. +Lightning Drives are shared app storage that allow you to share files between :doc:`LightningWork (Work) <../../core_api/lightning_work/index>` components, so that you distributed components can share files when running on the cloud. Using drives, you can run your Lightning App both locally and in the cloud without changing the code. The Drive object provides a central place for your components to share data. diff --git a/docs/source-app/levels/advanced/level_17.rst b/docs/source-app/levels/advanced/level_17.rst index 7f0f505410..6650860eaa 100644 --- a/docs/source-app/levels/advanced/level_17.rst +++ b/docs/source-app/levels/advanced/level_17.rst @@ -3,7 +3,7 @@ Level 17: Rerun components ########################## **Audience:** Users who want Work.run() to activate multiple times in an app. -**Prereqs:** Level 16+ and read the `Event Loop guide <../glossary/event_loop.html>`_. +**Prereqs:** Level 16+ and read the :doc:`Event Loop guide <../../glossary/event_loop>`. ---- diff --git a/docs/source-app/levels/advanced/level_18.rst b/docs/source-app/levels/advanced/level_18.rst index c934d2fd08..87fba3eb8b 100644 --- a/docs/source-app/levels/advanced/level_18.rst +++ b/docs/source-app/levels/advanced/level_18.rst @@ -3,7 +3,7 @@ Level 18: Share objects between LightningWorks ############################################## **Audience:** Users moving DataFrames or outputs, between Lightning Works (usually data engineers). -**Prereqs:** Level 16+ and know about the Pandas library and read the `Access app state guide <../../access_app_state.html>`_. +**Prereqs:** Level 16+ and know about the Pandas library and read the :doc:`Access app state guide <../../workflows/access_app_state>`. ---- diff --git a/docs/source-app/levels/advanced/start_dynamic_components.rst b/docs/source-app/levels/advanced/start_dynamic_components.rst index 39bc153e91..954cb64c26 100644 --- a/docs/source-app/levels/advanced/start_dynamic_components.rst +++ b/docs/source-app/levels/advanced/start_dynamic_components.rst @@ -3,7 +3,7 @@ Level: Start dynamic components ############################### **Audience:** Users who want to run a Lightning Component in parallel (asynchroneously). -**Prereqs:** You must have finished the `Basic levels <../basic/>`_. +**Prereqs:** You must have finished the :doc:`Basic levels <../basic/index>`. ---- diff --git a/docs/source-app/levels/basic/build_a_lightning_component.rst b/docs/source-app/levels/basic/build_a_lightning_component.rst index 62f356614f..00b777e150 100644 --- a/docs/source-app/levels/basic/build_a_lightning_component.rst +++ b/docs/source-app/levels/basic/build_a_lightning_component.rst @@ -13,7 +13,7 @@ Why you need Lightning components A Lightning component is a self-contained, modular machine-learning component that you can plug into your existing ML workflows. A Lightning component organizes arbitrary code so it can run on the cloud, manages its own infrastructure, cloud costs, networking and more. Connect components using your current workflow management tools or -our `next-generation reactive orchestrator <../intermediate/index.html>`_. +our :doc:`next-generation reactive orchestrator <../intermediate/index>`. Components run on the cloud or your laptop without code changes 🤯🤯. diff --git a/docs/source-app/levels/basic/real_lightning_component_implementations.rst b/docs/source-app/levels/basic/real_lightning_component_implementations.rst index a814a749d0..391bda9ada 100644 --- a/docs/source-app/levels/basic/real_lightning_component_implementations.rst +++ b/docs/source-app/levels/basic/real_lightning_component_implementations.rst @@ -3,7 +3,7 @@ Level 2: Explore real component implementations ############################################### **Audience:** Users who want to deeply understand what is possible with Lightning components. -**Prereqs:** You must have finished `level 1 <../basic/build_a_lightning_component.html>`_. +**Prereqs:** You must have finished :doc:`level 1 <../basic/build_a_lightning_component>`. ---- diff --git a/docs/source-app/levels/basic/save_money_on_cloud_costs.rst b/docs/source-app/levels/basic/save_money_on_cloud_costs.rst index c86754a77a..b2ff007ca8 100644 --- a/docs/source-app/levels/basic/save_money_on_cloud_costs.rst +++ b/docs/source-app/levels/basic/save_money_on_cloud_costs.rst @@ -3,7 +3,7 @@ Level 3: Save money on cloud costs ################################## **Audience:** Users who want to use the AWS cloud efficiently. -**Prereqs:** You must have finished `level 1 <../basic/build_a_lightning_component.html>`_. +**Prereqs:** You must have finished :doc:`level 1 <../basic/build_a_lightning_component>`. ---- diff --git a/docs/source-app/levels/intermediate/connect_lightning_components.rst b/docs/source-app/levels/intermediate/connect_lightning_components.rst index c512969862..31f6cc1516 100644 --- a/docs/source-app/levels/intermediate/connect_lightning_components.rst +++ b/docs/source-app/levels/intermediate/connect_lightning_components.rst @@ -4,7 +4,7 @@ Level 4: Connect components into a full stack AI app **Audience:** Users who want to build apps with multiple components. -**Prereqs:** You know how to `build a component <../basic/build_a_lightning_component.html>`_. +**Prereqs:** You know how to :doc:`build a component <../basic/build_a_lightning_component>`. ---- @@ -12,7 +12,7 @@ Level 4: Connect components into a full stack AI app What is a full stack AI app? **************************** In the ML world, workflows coordinate multiple pieces of code working together. In Lightning, -when we coordinate 2 or more `Lightning components <../basic/build_a_lightning_component.html>`_ working together, +when we coordinate 2 or more :doc:`Lightning components <../basic/build_a_lightning_component>` working together, we instead call it a Lightning App. The difference will become more obvious when we introduce reactive workflows in the advanced section. @@ -20,7 +20,7 @@ For the time being, we'll go over how to coordinate 2 components together in a t and explain how it works. .. note:: If you've used workflow tools for Python, this page describes conventional DAGs. - In `level 6 <./run_lightning_work_in_parallel.html>`_, we introduce reactive workflows that generalize beyond DAGs + In :doc:`level 6 `, we introduce reactive workflows that generalize beyond DAGs so you can build complex systems without much effort. ---- diff --git a/docs/source-app/levels/intermediate/debug_a_lightning_app.rst b/docs/source-app/levels/intermediate/debug_a_lightning_app.rst index ddc28ccede..8fdc7c67ae 100644 --- a/docs/source-app/levels/intermediate/debug_a_lightning_app.rst +++ b/docs/source-app/levels/intermediate/debug_a_lightning_app.rst @@ -3,7 +3,7 @@ Level 5: Debug A Lightning app ############################## **Audience:** Users who want to debug a distributed app locally. -**Prereqs:** You must have finished the `Basic levels <../basic/>`_. +**Prereqs:** You must have finished the :doc:`Basic levels <../basic/index>`. ---- diff --git a/docs/source-app/levels/intermediate/embed_web_ui_into_lightningwork.rst b/docs/source-app/levels/intermediate/embed_web_ui_into_lightningwork.rst index 3be6a9ed0d..354a82023f 100644 --- a/docs/source-app/levels/intermediate/embed_web_ui_into_lightningwork.rst +++ b/docs/source-app/levels/intermediate/embed_web_ui_into_lightningwork.rst @@ -3,7 +3,7 @@ Level 9: Embed graphical UIs into work ###################################### **Audience:** Users who need to embed a Graphical UI in their Lightning Apps. -**Prereqs:** You have finished `Level 8 `_. +**Prereqs:** You have finished :doc:`Level 8 `. ---- diff --git a/docs/source-app/levels/intermediate/run_lightning_work_in_parallel.rst b/docs/source-app/levels/intermediate/run_lightning_work_in_parallel.rst index b74fdacb9d..615ab98059 100644 --- a/docs/source-app/levels/intermediate/run_lightning_work_in_parallel.rst +++ b/docs/source-app/levels/intermediate/run_lightning_work_in_parallel.rst @@ -3,7 +3,7 @@ Level 6: Run a Lightning component in parallel ############################################## **Audience:** Users who want to run a Lightning Component in parallel (asynchroneously). -**Prereqs:** You must have finished `Level 5 `_. +**Prereqs:** You must have finished :doc:`Level 5 `. ---- diff --git a/docs/source-app/levels/intermediate/start_from_lightning_app_templates.rst b/docs/source-app/levels/intermediate/start_from_lightning_app_templates.rst index ceb497cea6..2b5ae06e48 100644 --- a/docs/source-app/levels/intermediate/start_from_lightning_app_templates.rst +++ b/docs/source-app/levels/intermediate/start_from_lightning_app_templates.rst @@ -3,7 +3,7 @@ Level 10: Start from lightning app templates ############################################ **Audience:** All users who want to move quickly with Lightning -**Prereqs:** You have finished `Level 9 `_. +**Prereqs:** You have finished :doc:`Level 9 `. ---- diff --git a/docs/source-app/ui_and_frontends.rst b/docs/source-app/ui_and_frontends.rst index 53e50cd534..3ffa5f983e 100644 --- a/docs/source-app/ui_and_frontends.rst +++ b/docs/source-app/ui_and_frontends.rst @@ -15,7 +15,7 @@ You can easily embed other tools and services (like a GitHub repo, a `FastAPI Se To get started, you can use built-in templates for the following frameworks: * `React.js `_ -* `StreamLit `_ +* `StreamLit `_ diff --git a/docs/source-app/workflows/access_app_state/access_app_state.rst b/docs/source-app/workflows/access_app_state.rst similarity index 97% rename from docs/source-app/workflows/access_app_state/access_app_state.rst rename to docs/source-app/workflows/access_app_state.rst index 1e233281fb..1f7e1258a4 100644 --- a/docs/source-app/workflows/access_app_state/access_app_state.rst +++ b/docs/source-app/workflows/access_app_state.rst @@ -38,7 +38,7 @@ For example, here we define a **Flow** component and **Work** component, where t You can easily check the state of your entire App as follows: -.. literalinclude:: ../../code_samples/quickstart/app_01.py +.. literalinclude:: ../code_samples/quickstart/app_01.py Run the App with: diff --git a/docs/source-app/workflows/add_components/index.rst b/docs/source-app/workflows/add_components.rst similarity index 88% rename from docs/source-app/workflows/add_components/index.rst rename to docs/source-app/workflows/add_components.rst index ca95e44e18..3edff4c1c0 100644 --- a/docs/source-app/workflows/add_components/index.rst +++ b/docs/source-app/workflows/add_components.rst @@ -28,4 +28,4 @@ Contribute a component ********************** One of the first principles of the Lightning community is to code something *once* for the benefit or everyone! -To contribute a component, `follow this guide <../build_lightning_component/index.html>`_. +To contribute a component, :doc:`follow this guide `. diff --git a/docs/source-app/workflows/add_web_ui/dash/intermediate.rst b/docs/source-app/workflows/add_web_ui/dash/intermediate.rst index c13b34b0a7..5c5da1a194 100644 --- a/docs/source-app/workflows/add_web_ui/dash/intermediate.rst +++ b/docs/source-app/workflows/add_web_ui/dash/intermediate.rst @@ -3,7 +3,7 @@ Add a web UI with Dash (intermediate) ##################################### **Audience:** Users who want to communicate between the Lightning App and Dash. -**Prereqs:** Must have read the `dash basic `_ guide. +**Prereqs:** Must have read the :doc:`dash basic ` guide. ---- diff --git a/docs/source-app/workflows/add_web_ui/html/intermediate.rst b/docs/source-app/workflows/add_web_ui/html/intermediate.rst index e2d0f965ca..17b6b585c0 100644 --- a/docs/source-app/workflows/add_web_ui/html/intermediate.rst +++ b/docs/source-app/workflows/add_web_ui/html/intermediate.rst @@ -3,7 +3,7 @@ Add a web UI with HTML (intermediate) ##################################### **Audience:** Users who want to add a web UI using plain html. -**Prereqs:** Must have read the `html basic `_ guide. +**Prereqs:** Must have read the :doc:`html basic ` guide. ---- diff --git a/docs/source-app/workflows/add_web_ui/panel/basic.rst b/docs/source-app/workflows/add_web_ui/panel/basic.rst index 8e72036fec..1f04987eaa 100644 --- a/docs/source-app/workflows/add_web_ui/panel/basic.rst +++ b/docs/source-app/workflows/add_web_ui/panel/basic.rst @@ -147,7 +147,7 @@ First, find the Panel app you want to integrate. In this example, that app looks pn.panel("Hello **Panel ⚡** World").servable() -Refer to the `Panel documentation `_ and `awesome-panel.org `_ for more complex examples. +Refer to the `Panel documentation `_ and `awesome-panel.org `_ for more complex examples. ---- diff --git a/docs/source-app/workflows/add_web_ui/panel/intermediate.rst b/docs/source-app/workflows/add_web_ui/panel/intermediate.rst index be09e98fe6..20cf141248 100644 --- a/docs/source-app/workflows/add_web_ui/panel/intermediate.rst +++ b/docs/source-app/workflows/add_web_ui/panel/intermediate.rst @@ -6,7 +6,7 @@ Add a web UI with Panel (intermediate) **Audience:** Users who want to communicate between the Lightning App and Panel. -**Prereqs:** Must have read the `Panel basic `_ guide. +**Prereqs:** Must have read the :doc:`Panel basic ` guide. ---- diff --git a/docs/source-app/workflows/add_web_ui/react/communicate_between_react_and_lightning.rst b/docs/source-app/workflows/add_web_ui/react/communicate_between_react_and_lightning.rst index be92d75877..63b92beea6 100644 --- a/docs/source-app/workflows/add_web_ui/react/communicate_between_react_and_lightning.rst +++ b/docs/source-app/workflows/add_web_ui/react/communicate_between_react_and_lightning.rst @@ -13,11 +13,11 @@ Communicate Between React and Lightning Example code ************ To illustrate how to communicate between a React app and a lightning App, we'll be using the `example_app.py` file -which `lightning init react-ui `_ created: +which :doc:`lightning init react-ui ` created: .. literalinclude:: ../../../../../src/lightning/app/cli/react-ui-template/example_app.py -and the App.tsx file also created by `lightning init react-ui `_: +and the App.tsx file also created by :doc:`lightning init react-ui `: .. literalinclude:: ../../../../../src/lightning/app/cli/react-ui-template/ui/src/App.tsx diff --git a/docs/source-app/workflows/add_web_ui/react/connect_react_and_lightning.rst b/docs/source-app/workflows/add_web_ui/react/connect_react_and_lightning.rst index 1fb78d1674..034e031d5a 100644 --- a/docs/source-app/workflows/add_web_ui/react/connect_react_and_lightning.rst +++ b/docs/source-app/workflows/add_web_ui/react/connect_react_and_lightning.rst @@ -13,11 +13,11 @@ Connect React to a Lightning app Example code ************ To illustrate how to connect a React app and a lightning App, we'll be using the `example_app.py` file -which `lightning init react-ui `_ created: +which :doc:`lightning init react-ui ` created: .. literalinclude:: ../../../../../src/lightning/app/cli/react-ui-template/example_app.py -and the App.tsx file also created by `lightning init react-ui `_: +and the App.tsx file also created by :doc:`lightning init react-ui `: .. literalinclude:: ../../../../../src/lightning/app/cli/react-ui-template/ui/src/App.tsx diff --git a/docs/source-app/workflows/add_web_ui/streamlit/intermediate.rst b/docs/source-app/workflows/add_web_ui/streamlit/intermediate.rst index bd10fe623c..a89b6e6a5c 100644 --- a/docs/source-app/workflows/add_web_ui/streamlit/intermediate.rst +++ b/docs/source-app/workflows/add_web_ui/streamlit/intermediate.rst @@ -3,7 +3,7 @@ Add a web UI with Streamlit (intermediate) ########################################## **Audience:** Users who want to communicate between the Lightning App and Streamlit. -**Prereqs:** Must have read the `streamlit basic `_ guide. +**Prereqs:** Must have read the :doc:`streamlit basic ` guide. ---- diff --git a/docs/source-app/workflows/build_lightning_component/index_content.rst b/docs/source-app/workflows/build_lightning_component/index_content.rst index abf26e38a2..9a940bc8b8 100644 --- a/docs/source-app/workflows/build_lightning_component/index_content.rst +++ b/docs/source-app/workflows/build_lightning_component/index_content.rst @@ -3,7 +3,7 @@ :hidden: basic - ../add_components/index + ../add_components .. toctree:: :maxdepth: 1 diff --git a/docs/source-app/workflows/build_lightning_component/intermediate.rst b/docs/source-app/workflows/build_lightning_component/intermediate.rst index f38f7c7396..b95ba36ca4 100644 --- a/docs/source-app/workflows/build_lightning_component/intermediate.rst +++ b/docs/source-app/workflows/build_lightning_component/intermediate.rst @@ -11,7 +11,7 @@ Add a web user interface (UI) ***************************** Every lightning component can have its own user interface (UI). Lightning components support any kind of UI interface such as dash, gradio, panel, react.js, streamlit, vue.js, web urls, -etc...(`full list here <../add_web_ui/index.html>`_). +etc...(:doc:`full list here <../add_web_ui/index>`). Let's say that we have a user interface defined in html: diff --git a/docs/source-app/workflows/extend_app.rst b/docs/source-app/workflows/extend_app.rst index 2e17af481b..bc7ffd7d2f 100644 --- a/docs/source-app/workflows/extend_app.rst +++ b/docs/source-app/workflows/extend_app.rst @@ -16,7 +16,7 @@ You can extend a Lightning App by using community components or building your ow :header: Add more Components :description: Extend an App by adding a prebuilt component. :col_css: col-md-4 - :button_link: add_components/index.html + :button_link: add_components.html :height: 150 :tag: basic diff --git a/docs/source-app/workflows/index.rst b/docs/source-app/workflows/index.rst index 95d8198b62..9993971873 100644 --- a/docs/source-app/workflows/index.rst +++ b/docs/source-app/workflows/index.rst @@ -2,7 +2,7 @@ :maxdepth: 1 :hidden: - access_app_state/access_app_state + access_app_state add_web_ui/index add_web_link secrets <../glossary/secrets> @@ -35,7 +35,7 @@ How to: :header: Access the App State :description: Learn to work with the app state :col_css: col-md-4 - :button_link: access_app_state/access_app_state.html + :button_link: access_app_state.html :height: 180 .. displayitem:: diff --git a/docs/source-app/workflows/run_app_on_cloud/cloud_files.rst b/docs/source-app/workflows/run_app_on_cloud/cloud_files.rst index dfef0dc1c1..190255fef8 100644 --- a/docs/source-app/workflows/run_app_on_cloud/cloud_files.rst +++ b/docs/source-app/workflows/run_app_on_cloud/cloud_files.rst @@ -36,7 +36,7 @@ For example, the source code directory below with the ``.lightningignore`` file model.pt data_dir -A sample ``.lightningignore`` file can be found `here `_. +A sample ``.lightningignore`` file can be found `here `_. If you are a component author and your components creates local files that you want to ignore, you can do: diff --git a/docs/source-app/workflows/run_work_in_parallel.rst b/docs/source-app/workflows/run_work_in_parallel.rst index 90c7b7b93c..4f31583926 100644 --- a/docs/source-app/workflows/run_work_in_parallel.rst +++ b/docs/source-app/workflows/run_work_in_parallel.rst @@ -3,7 +3,7 @@ Run LightningWork in parallel ############################# **Audience:** Users who want to run a LightningWork in parallel (asynchroneously). -**Prereqs:** You must have finished the `Basic levels <../basic/>`_. +**Prereqs:** You must have finished the :doc:`Basic levels <../levels/basic/index>`. ---- diff --git a/docs/source-app/workflows/run_work_once.rst b/docs/source-app/workflows/run_work_once.rst index 240cde3d08..8bdd576a2b 100644 --- a/docs/source-app/workflows/run_work_once.rst +++ b/docs/source-app/workflows/run_work_once.rst @@ -6,7 +6,7 @@ Cache LightningWork Runs **Level:** Advanced -**Prereqs**: Level 16+ and read the `Event Loop guide <../glossary/event_loop.html>`_. +**Prereqs**: Level 16+ and read the :doc:`Event Loop guide <../glossary/event_loop>`. ---- diff --git a/docs/source-app/workflows/run_work_once_content.rst b/docs/source-app/workflows/run_work_once_content.rst index c1890fe9ec..0b79010321 100644 --- a/docs/source-app/workflows/run_work_once_content.rst +++ b/docs/source-app/workflows/run_work_once_content.rst @@ -17,7 +17,7 @@ You can turn caching on or off: work = MyWork(cache_calls=False) To better understand this, imagine that every day you want to sequentially download and process some data and then train a model on that data. -As explained in the `Event Loop guide <../glossary/event_loop.html>`_, the Lightning App runs within an infinite while loop, so the pseudo-code of your application might looks like this: +As explained in the :doc:`Event Loop guide <../../glossary/event_loop>`, the Lightning App runs within an infinite while loop, so the pseudo-code of your application might looks like this: .. code-block:: python diff --git a/docs/source-app/workflows/share_app.rst b/docs/source-app/workflows/share_app.rst index 87045bde8d..8d7482e21d 100644 --- a/docs/source-app/workflows/share_app.rst +++ b/docs/source-app/workflows/share_app.rst @@ -14,7 +14,7 @@ To share an app, simply run your app on the cloud: lightning run app app.py --cloud -Then share the link that's generated (`like this one `_). +Then share the link that's generated. ----