Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs Homepage #23

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Binary file added core/_static/assets/home/active-cooling-kit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/compliance.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/contact-us.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/faq.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/grayskull.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/software-utilities.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/t1000.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/t7000.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/tt-buda.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/tt-loudbox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/tt-metalium.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/tt-mlir.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/tt-nn.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/tt-quietbox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/warp-100-bridge.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added core/_static/assets/home/wormhole.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
271 changes: 271 additions & 0 deletions core/_templates/home.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,271 @@
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Tenstorrent Documentation</title>
<style>
@font-face {
font-family: "Degular";
src: url("./fonts/DegularText-Medium.woff") format("woff"),
url("./fonts/DegularText-Medium.woff2") format("woff2");
}
@font-face {
font-family: "DegularDisplay";
src: url("./fonts/DegularDisplay-Light.woff") format("woff"),
url("./fonts/DegularDisplay-Light.woff2") format("woff2");
}

body {
font-family: "Degular", sans-serif;
margin: 0;
padding: 0;
background-color: #f8f9fa;
color: #333;
}

.container {
display: flex;
flex-direction: column;
}

.hx {
font-size: 48px;
line-height: 90%;
font-family: "DegularDisplay", sans-serif;
}

.section {
display: flex;
flex-direction: column;
border-bottom: 1px solid #ccc;
gap: 24px;
padding: 36px 0 24px;
}

.section:last-child {
margin-bottom: 36px;
}

.section h2 {
margin: 0 !important;
margin-bottom: 0 !important;
line-height: 90%;
}

.grid {
display: flex;
flex-wrap: wrap;
gap: 18px;
}

.card {
display: flex;
flex-direction: column;
background-color: #edeff9;
border-radius: 10px;
overflow: hidden;
width: 100%;
gap: 16px;
padding: 18px;
transition: background-color 100ms ease-in;
}

.card:hover {
background-color: #d7dbeb;
}

.card * {
color: #202020 !important;
}

.small-card {
width: calc(50% - 10px);
padding: 12px;
gap: 8px;
}

.card img {
width: 100%;
height: auto;
}

.card h3 {
font-family: "Degular", sans-serif;
margin: 0;
margin-bottom: 1rem;
}

.small-card h4 {
font-weight: normal;
font-size: 16px;
margin-bottom: 0.5rem;
}

@media (min-width: 769px) {
.hx {
font-size: 56px;
}

.card {
width: calc(50% - 9px);
}

.small-card {
width: calc(33% - 10.2px);
gap: 16px;
}
}

@media (min-width: 1024px) {
.hx {
font-size: 96px;
}
}

@media (min-width: 1280px) {
.card h3 {
font-size: 32px;
}

.small-card h4 {
font-size: 22px;
}
}

@media (min-width: 1536px) {
.hx {
font-size: 108px;
}
}

@media (min-width: 1920) {
.hx {
font-size: 144px;
}
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dimitri-tenstorrent

This change should fix the scroll bars appearing. These scrollbars show when users have "Show scroll bars" set to "Always" (on macOS - imagine Windows is similar but unable to test).

In shared/_static/tt-theme.css, overflow-x: scroll is set for header elements:

/* Document styling */

.document * h1,
.document * h2,
.document * h3,
.document * h4 {
  /* vertically center document header links */
  display: flex;
  align-items: center;
  gap: 0.5rem;
  max-width: 100%;
  overflow-x: scroll; /* here */
}

This override prevents the above from applying scrollbars to header elements. When you have a chance, could you pull and take a look at this, please?

Let me know if you're still seeing any issues on your end.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mwvd Not seeing the issue anymore.

/* Override tt-theme.css */
.document * h1, .document * h2, .document * h3, .document * h4 {
/*
Remove horizontal overflow (so scrollbars don't appear on every header
element for users with "Show scroll bars" set to "Always" on macOS)
*/
overflow: hidden;
}
</style>
</head>
<body>
<div class="container">
<h1 class="hx">Tenstorrent<br />Documentation</h1>

<div class="section">
<h2>Add-in Boards</h2>
<div class="grid">
<a href="aibs/grayskull" class="card">
<img src="_static/home/grayskull.png" alt="Grayskull™" />
<h3>Grayskull™</h3>
</a>
<a href="aibs/wormhole" class="card">
<img src="_static/home/wormhole.png" alt="Wormhole™" />
<h3>Wormhole™</h3>
</a>
<a href="aibs/ack" class="card small-card">
<img src="_static/home/warp-100-bridge.png" alt="Warp 100 Bridge" />
<h4>Warp 100 Bridge</h4>
</a>
<a href="aibs/warp100" class="card small-card">
<img
src="_static/home/active-cooling-kit.png"
alt="Active Cooling Kit"
/>
<h4>Active Cooling Kit</h4>
</a>
</div>
</div>

<div class="section">
<h2>Systems</h2>
<div class="grid">
<a href="systems/quietbox" class="card">
<img src="_static/home/tt-quietbox.png" alt="TT-QuietBox" />
<h3>TT-QuietBox</h3>
</a>
<a href="systems/t3000" class="card">
<img src="_static/home/tt-loudbox.png" alt="TT-LoudBox" />
<h3>TT-LoudBox</h3>
</a>
<a href="systems/t7000" class="card small-card">
<img src="_static/home/t7000.png" alt="T7000" />
<h4>T7000</h4>
</a>
<a href="systems/t1000" class="card small-card">
<img src="_static/home/t1000.png" alt="T1000" />
<h4>T1000</h4>
</a>
</div>
</div>

<div class="section">
<h2>Software</h2>
<div class="grid">
<a
target="_blank"
href="https://tenstorrent.github.io/ttnn/latest/index.html"
class="card small-card"
>
<img src="_static/home/tt-nn.png" alt="TT-NN" />
<h4>TT-NN</h4>
</a>
<a
target="_blank"
href="https://tenstorrent.github.io/pybuda/latest/index.html"
class="card small-card"
>
<img src="_static/home/tt-buda.png" alt="TT-Buda™" />
<h4>TT-Buda™</h4>
</a>
<a
target="_blank"
href="https://tenstorrent.github.io/tt-metalium/latest/index.html"
class="card small-card"
>
<img src="_static/home/tt-metalium.png" alt="TT-Metalium™" />
<h4>TT-Metalium™</h4>
</a>
<a
target="_blank"
href="https://docs.tenstorrent.com/tt-mlir/"
class="card small-card"
>
<img src="_static/home/tt-mlir.png" alt="TT-MLIR" />
<h4>TT-MLIR</h4>
</a>
</div>
</div>

<div class="section">
<h2>Support</h2>
<div class="grid">
<a
target="_blank"
href="https://tenstorrent.com/faq"
class="card small-card"
>
<img src="_static/home/faq.png" alt="FAQ" />
<h4>FAQ</h4>
</a>
<a href="support/README.html" class="card small-card">
<img src="_static/home/compliance.png" alt="Compliance" />
<h4>Compliance</h4>
</a>
<a
target="_blank"
href="https://tenstorrent.com/contact"
class="card small-card"
>
<img src="_static/home/contact-us.png" alt="Contact Us" />
<h4>Contact Us</h4>
</a>
</div>
</div>
</div>
</body>
6 changes: 3 additions & 3 deletions core/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import os

project = 'Home'
copyright = '2024, Tenstorrent'
copyright = '2025, Tenstorrent'
author = 'Tenstorrent'
release = '1.0'

Expand All @@ -25,7 +25,7 @@
html_theme = "sphinx_rtd_theme"
html_logo = "../shared/images/tt_logo.svg"
html_favicon = "../shared/images/favicon.png"
html_static_path = ['../shared/_static']
html_static_path = ['../shared/_static', '_static/assets']
html_last_updated_fmt = "%b %d, %Y"

html_context = {
Expand All @@ -35,4 +35,4 @@

def setup(app):
app.add_css_file("tt_theme.css")

app.add_css_file("home.css")
3 changes: 3 additions & 0 deletions core/index.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
Tenstorrent
==============================

.. raw:: html
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we use :include: tag here and have the HTML inside of home.html?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes- much better idea- I'll do this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Couldn't figure this out with :include:, but was able to move the HTML into /core/_templates/home.html and then include it here with:

.. raw:: html
   :file: _templates/home.html

:file: _templates/home.html

.. include:: quickstart.md
:parser: myst_parser.sphinx_

Expand Down
2 changes: 1 addition & 1 deletion pybuda/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# from ..conf import *

project = 'TT Buda'
copyright = '2024, Tenstorrent'
copyright = '2025, Tenstorrent'
author = 'Tenstorrent'
root_doc = "toc"
templates_path = ['../shared/_templates']
Expand Down
8 changes: 8 additions & 0 deletions shared/_static/home.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/*
For use in /core only (see /core/conf.py)
Hides sphinx generated homepage header (https://docs.tenstorrent.com/)
*/

#tenstorrent > h1 {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can I not remove it via deleting the first two lines of index.rst

Tenstorrent
==============================

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tenstorrent
==============================

Removing this seems to make the page title default to the closest header:

Screenshot 2024-11-25 at 10 56 50 AM

display: none !important;
}
2 changes: 1 addition & 1 deletion shared/example-conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import os

project = 'Tenstorrent'
copyright = '2024, Tenstorrent'
copyright = '2025, Tenstorrent'
author = 'Tenstorrent'

templates_path = ['shared/_templates']
Expand Down
2 changes: 1 addition & 1 deletion syseng/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# from ..conf import *

project = 'Software and Utilities'
copyright = '2024, Tenstorrent'
copyright = '2025, Tenstorrent'
author = 'Tenstorrent'
root_doc = "index"
templates_path = ['../shared/_templates']
Expand Down