Add the ExecuTorch logo to the ET landing page. (#907)

svekars · dbort · commit 4f09d7b7d7d6 · 2023-10-16T15:51:49.000-07:00
Summary: Pull Request resolved: #907 - Add the ExecuTorch logo to the index.rst landing page - Modify css to have two-column layout. Reviewed By: mergennachin Differential Revision: D50281822 fbshipit-source-id: 05aed66720775096fd0313115872555bb8cfca39
diff --git a/docs/README.md b/docs/README.md
@@ -161,9 +161,6 @@ outside of the `docs/source` directory, complete the following steps:
 2. Include the following in that file:
 
    ````
-   ---
-   orphan: true
-   ---
    ```{include} ../path-to-your-file/outside-of-the-docs-dir.md```
    ````
 
diff --git a/docs/source/_static/css/custom.css b/docs/source/_static/css/custom.css
@@ -120,3 +120,43 @@ details.sd-dropdown .sd-summary-content {
 details.sd-dropdown .highlight .n {
     font-weight: normal;
 }
+
+.et-page-column1 {
+  float: left;
+  width: 70%;
+  font-size: 1rem;
+}
+
+.et-page-column2 {
+  float: right;
+  padding-top: 40px;
+  padding-left: 60px;
+  padding-right: 60px;
+  padding-bottom: 60px;
+  width: 30%;
+}
+
+.et-page-column-row:after {
+  content: "";
+  display: table;
+  clear: both;
+}
+
+/* For screens smaller than 768px (typical mobile devices) */
+@media screen and (max-width: 768px) {
+  .et-page-column1, .et-page-column2 {
+    float: none; /* Remove floats */
+    width: 100%; /* Full width for both columns */
+    padding: 0;
+    font-size: 1rem;
+  }
+
+  .et-page-column2 img {
+    display: none;
+  }
+  .et-page-column-row:after {
+    content: "";
+    display: table;
+    clear: both;
+  }
+}
diff --git a/docs/source/_static/img/ExecuTorch-Logo-cropped.svg b/docs/source/_static/img/ExecuTorch-Logo-cropped.svg
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   id="Layer_2"
+   viewBox="0 0 51.200001 38.52"
+   width="51.200001"
+   height="38.52"
+   version="1.1"
+   sodipodi:docname="ExecuTorch-Logo-cropped.svg"
+   inkscape:version="1.2.1 (9c6d41e4, 2022-07-14)"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <sodipodi:namedview
+     id="namedview15"
+     pagecolor="#ffffff"
+     bordercolor="#000000"
+     borderopacity="0.25"
+     inkscape:showpageshadow="2"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#d1d1d1"
+     showgrid="false"
+     inkscape:zoom="8.0613964"
+     inkscape:cx="18.235054"
+     inkscape:cy="7.6289512"
+     inkscape:window-width="1680"
+     inkscape:window-height="819"
+     inkscape:window-x="0"
+     inkscape:window-y="25"
+     inkscape:window-maximized="0"
+     inkscape:current-layer="Layer_2" />
+  <defs
+     id="defs4">
+    <style
+       id="style2">.cls-1{fill:#cc2faa;}</style>
+  </defs>
+  <path
+     class="cls-1"
+     d="m 26.89,12.15 c 1.27,-1.27 3.33,-1.27 4.59,0 1.26,1.27 1.26,3.32 0,4.59 -1.26,1.27 -3.33,1.27 -4.59,0 -1.26,-1.27 -1.26,-3.32 0,-4.59"
+     id="path6" />
+  <polygon
+     class="cls-1"
+     points="16.1,27.25 16.11,21.52 39.95,45.19 51.49,45.17 51.53,22.49 55.6,18.42 55.55,49.23 38.27,49.26 "
+     id="polygon8"
+     transform="translate(-4.4,-10.74)" />
+  <polygon
+     class="cls-1"
+     points="4.4,41.62 4.45,10.77 21.74,10.74 30.38,19.31 27.5,22.19 20.05,14.81 8.52,14.83 8.48,37.55 "
+     id="polygon10"
+     transform="translate(-4.4,-10.74)" />
+  <polygon
+     class="cls-1"
+     points="39.52,28.41 44.48,33.33 44.47,39.06 36.66,31.31 "
+     id="polygon12"
+     transform="translate(-4.4,-10.74)" />
+</svg>
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -72,7 +72,7 @@
     "xml",  # {repo_root}/docs/cpp/build/xml
 )
 
-
+html_favicon = "_static/img/ExecuTorch-Logo-cropped.svg"
 breathe_projects = {"ExecuTorch": "../build/xml/"}
 breathe_default_project = "ExecuTorch"
 
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -13,17 +13,14 @@ Welcome to the ExecuTorch Documentation
    `GitHub repository <https://github.com/pytorch/executorch/issues>`__ for bug
    reporting.
 
-**ExecuTorch** is a PyTorch platform that provides infrastructure to run
-PyTorch programs everywhere from AR/VR wearables to standard on-device
-iOS and Android mobile deployments. One of the main
-goals for ExecuTorch is to enable wider customization and deployment
-capabilities of the PyTorch programs.
-
-ExecuTorch heavily relies on such PyTorch technologies as `torch.compile
-<https://pytorch.org/docs/stable/torch.compiler.html>`__ and `torch.export
-<https://pytorch.org/docs/main/export.html>`__. If you are not familiar with
-these APIs, you might want to read about them in the PyTorch documentation
-before diving into the ExecuTorch documentation.
+.. raw:: html
+
+   <div class="et-page-column-row">
+     <div class="et-page-column1"><p><strong>ExecuTorch</strong> is a PyTorch platform that provides infrastructure to run PyTorch programs everywhere from AR/VR wearables to standard on-device iOS and Android mobile deployments. One of the main goals for ExecuTorch is to enable wider customization and deployment capabilities of the PyTorch programs.</p>
+     <p>ExecuTorch heavily relies on such PyTorch technologies as <a href="https://pytorch.org/docs/stable/torch.compiler.html">torch.compile</a> and <a href="https://pytorch.org/docs/main/export.html">torch.export</a>. If you are not familiar with these APIs, you might want to read about them in the PyTorch documentation before diving into the ExecuTorch documentation.</p></div>
+     <div class="et-page-column2"><img src="_static/img/ExecuTorch-Logo-cropped.svg" alt="ExecuTorch logo" title="ExecuTorch logo"></div>
+   </div>
+
 
 Getting Started
 ~~~~~~~~~~~~~~~

Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@`
`72`	`72`	`"xml", # {repo_root}/docs/cpp/build/xml`
`73`	`73`	`)`
`74`	`74`
`75`		`-`
	`75`	`+html_favicon = "_static/img/ExecuTorch-Logo-cropped.svg"`
`76`	`76`	`breathe_projects = {"ExecuTorch": "../build/xml/"}`
`77`	`77`	`breathe_default_project = "ExecuTorch"`
`78`	`78`