Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ jobs:
uses: actions/checkout@v3
- name: 'Install dependencies'
run: |
pip install sphinx==8.1.3 sphinx_rtd_theme==3.0.1 nbsphinx==0.9.5 IPython ipython_genutils==0.2.0 ipywidgets==8.0.2 astroid==3.3.2
pip install sphinx==8.1.3 sphinx_rtd_theme==3.0.1 nbsphinx==0.9.5 IPython ipython_genutils==0.2.0 ipywidgets==8.0.2 astroid==3.3.2 sphinx-tabs==3.4.7
pip install breathe==4.35.0 sphinx-autoapi==3.3.2
sudo apt-get install -y pandoc graphviz doxygen
export GIT_SHA=$(git show-ref --hash HEAD)
Expand Down
60 changes: 60 additions & 0 deletions docs/_static/css/output-style.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
/* Custom styling for program output blocks */

.program-output {
background-color: #f8f9fa;
padding: 0; /* No padding at all */
margin: 0; /* No margins at all */
border-radius: 0; /* No rounded corners */
font-family: 'Courier New', monospace;
font-size: 14px;
line-height: 1.5;
width: 100%;
max-width: 100%;
}

.program-output pre {
margin: 0;
padding: 0;
background: transparent !important;
border: none !important;
color: #2c3e50;
width: 100%;
}

.program-output .highlight {
background: transparent !important;
margin: 0;
width: 100%;
}

/* Alternative lighter style */
.output-block {
background-color: #fafbfc;
border: 1px solid #e1e4e8;
padding: 10px 14px;
margin: 10px 0;
border-radius: 3px;
font-family: 'SF Mono', 'Consolas', monospace;
font-size: 13px;
color: #24292e;
}

/* Console-like output style */
.console-output {
background-color: #1e1e1e;
border-left: 3px solid #76b900;
padding: 14px 18px;
margin: 12px 0;
border-radius: 5px;
font-family: 'Fira Code', 'Consolas', monospace;
font-size: 13px;
color: #d4d4d4;
box-shadow: 0 2px 4px rgba(0,0,0,0.1);
}

.console-output pre {
margin: 0;
color: #d4d4d4;
background: transparent !important;
}

43 changes: 43 additions & 0 deletions docs/_static/css/rtabs.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
/* Custom styling for sphinx-tabs */

.sphinx-tabs {
margin-bottom: 1rem;
}

.sphinx-tabs-tab {
background-color: #f4f4f4;
border: 1px solid #ccc;
border-bottom: none;
padding: 0.5rem 1rem;
margin-right: 0.5rem;
cursor: pointer;
font-weight: 500;
transition: background-color 0.2s;
}

.sphinx-tabs-tab:hover {
background-color: #e0e0e0;
}

.sphinx-tabs-tab[aria-selected="true"] {
background-color: #76b900; /* NVIDIA green */
color: white;
border-color: #76b900;
margin-right: 0.5rem;
}

.sphinx-tabs-panel {
border: 1px solid #ccc;
padding: 1rem;
background-color: #f9f9f9;
}

/* Dark mode support for RTD theme */
.rst-content .sphinx-tabs-tab {
color: #333;
}

.rst-content .sphinx-tabs-tab[aria-selected="true"] {
color: white;
}

3 changes: 3 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
"nbsphinx",
"breathe",
"autoapi.extension",
"sphinx_tabs.tabs",
]

templates_path = ["_templates"]
Expand All @@ -83,6 +84,8 @@
html_css_files = [
"css/nvidia_font.css",
"css/nvidia_footer.css",
"css/rtabs.css",
"css/output-style.css",
]

html_theme_options = {
Expand Down
2 changes: 1 addition & 1 deletion docs/examples/advanced_optimizations.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
"id": "6dcbf25a",
"metadata": {},
"source": [
"This guide is a follow-up to the discussion in the [quickstart guide](quickstart.ipynb). We will focus on techniques to achieve maximum performance when training a basic GPT encoder layer. For convenience, we use some helper functions defined in [quickstart_utils.py](quickstart_utils.py). "
"This guide is a follow-up to the discussion in the [Getting Started guide](../getting_started/index.rst). We will focus on techniques to achieve maximum performance when training a basic GPT encoder layer. For convenience, we use some helper functions defined in [quickstart_utils.py](quickstart_utils.py). "
]
},
{
Expand Down
Loading
Loading