prepare space for fused docs (#14160)

* copy app conf

* ci + req.

* script symlink

* wip

* keep only App

* add also PL

* lightning

* artifact

Author: Borda

.github/workflows/docs-checks.yml

@@ -17,7 +17,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        pkg: ["app", "pytorch"]
+        pkg: ["app", "pytorch"]  # TODO: , "lit"
     steps:
       - uses: actions/checkout@v2
         with:
@@ -68,7 +68,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        pkg: ["app", "pytorch"]
+        pkg: ["app", "pytorch", "lit"]
     steps:
       - uses: actions/checkout@v2
         with:
@@ -112,7 +112,7 @@ jobs:
       - name: Upload built docs
         uses: actions/upload-artifact@v3
         with:
-          name: docs-results-${{ github.sha }}
+          name: docs-${{ matrix.pkg }}-${{ github.sha }}
           path: docs/build/html/
         # Use always() to always run this step to publish test results when there are test failures
         if: success()

.gitignore

@@ -9,6 +9,9 @@ lightning_logs/
 # Documentations
 docs/source-app/generated
 docs/source-app/*/generated
+docs/source-lit/generated
+docs/source-lit/*/generated
+docs/source-lit/api
 docs/source-pytorch/api
 docs/source-pytorch/*.md
 docs/source-pytorch/generated

Makefile

@@ -22,6 +22,9 @@ clean:
 	rm -rf ./docs/source-pytorch/api
 	rm -rf ./docs/source-app/generated
 	rm -rf ./docs/source-app/*/generated
+	rm -rf ./docs/source-lit/api
+	rm -rf ./docs/source-lit/generated
+	rm -rf ./docs/source-lit/*/generated
 	rm -rf build
 	rm -rf dist
 	rm -rf *.egg-info

docs/create-symlinks.py

@@ -0,0 +1,27 @@
+import glob
+import os
+
+
+def symlink_folder(source_dir, target_dir: str = "source-lit") -> None:
+    assert os.path.isdir(source_dir)
+    assert os.path.isdir(target_dir)
+    ls = glob.glob(os.path.join(source_dir, "**"), recursive=True)
+    for path_ in ls:
+        path_target = path_.replace(source_dir, target_dir)
+        if os.path.isdir(path_) or os.path.exists(path_target):
+            continue
+        if os.path.islink(path_target):
+            print(path_target)
+            continue
+        path_dir = os.path.dirname(path_target)
+        os.makedirs(path_dir, exist_ok=True)
+        depth = path_.count(os.path.sep)
+        path_root = os.path.sep.join([".."] * depth)
+        path_source = os.path.join(path_root, path_)
+        # print(path_source, path_target, os.path.exists(path_target))
+        os.symlink(path_source, path_target)
+
+
+if __name__ == "__main__":
+    for name in ("app", "pytorch"):
+        symlink_folder(f"source-{name}")

docs/source-app/code_samples/quickstart/app/app_0.py

@@ -1,6 +1,5 @@
-from docs.quickstart.app_02 import HourLongWork
-
 import lightning as L
+from docs.quickstart.app_02 import HourLongWork
 
 
 class RootFlow(L.LightningFlow):

docs/source-lit/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    = -T -W
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = ../build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/source-lit/_static/copybutton.js

@@ -0,0 +1 @@
+../../source-app/_static/copybutton.js

docs/source-lit/_static/images/accelerator/ipus/profiler.png

@@ -0,0 +1 @@
+../../../../../source-pytorch/_static/images/accelerator/ipus/profiler.png

docs/source-lit/_static/images/benchmarks/figure-parity-times.png

@@ -0,0 +1 @@
+../../../../source-pytorch/_static/images/benchmarks/figure-parity-times.png

docs/source-lit/_static/images/general/PTL101_youtube_thumbnail.jpg

@@ -0,0 +1 @@
+../../../../source-pytorch/_static/images/general/PTL101_youtube_thumbnail.jpg