Skip to content

Commit b5848f9

Browse files
committed
correct code block styling and "WARNING — Reproducibility"
1 parent 6378de4 commit b5848f9

File tree

7 files changed

+44
-145
lines changed

7 files changed

+44
-145
lines changed

.github/workflows/docs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@ name: Build & Deploy Sphinx Docs
33
on:
44
push:
55
branches:
6-
- page # тестовая ветка для preview
7-
- main # production deploy
6+
- page
7+
- main
88
pull_request:
99
branches:
10-
- main # проверка перед merge
10+
- main
1111

1212
permissions:
1313
contents: read

docs/_build/html/_static/styles/front_page.css

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,3 +197,19 @@ code {
197197
h1 { font-size: 1.5rem; }
198198
.badges img { height: 18px; }
199199
}
200+
/* Fix Sphinx weird highlighting for custom code blocks */
201+
pre, code {
202+
background: #2d2d2d !important;
203+
color: #eee !important;
204+
border-radius: 6px;
205+
}
206+
207+
pre {
208+
padding: 12px !important;
209+
overflow-x: auto;
210+
}
211+
212+
pre span {
213+
background: none !important;
214+
color: inherit !important;
215+
}

docs/_build/html/genindex.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<title>Index &#8212; LLMSQL 0.2.0 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8e8a900e" />
99
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=29da98fa" />
10-
<link rel="stylesheet" type="text/css" href="_static/styles/front_page.css?v=46e78057" />
10+
<link rel="stylesheet" type="text/css" href="_static/styles/front_page.css?v=ccf8d1d0" />
1111
<script src="_static/documentation_options.js?v=938c9ccc"></script>
1212
<script src="_static/doctools.js?v=9bcbadda"></script>
1313
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>

docs/_build/html/index.html

Lines changed: 0 additions & 135 deletions
This file was deleted.

docs/_build/html/search.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<title>Search &#8212; LLMSQL 0.2.0 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=8e8a900e" />
99
<link rel="stylesheet" type="text/css" href="_static/basic.css?v=29da98fa" />
10-
<link rel="stylesheet" type="text/css" href="_static/styles/front_page.css?v=46e78057" />
10+
<link rel="stylesheet" type="text/css" href="_static/styles/front_page.css?v=ccf8d1d0" />
1111

1212
<script src="_static/documentation_options.js?v=938c9ccc"></script>
1313
<script src="_static/doctools.js?v=9bcbadda"></script>

docs/_static/styles/front_page.css

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,3 +197,19 @@ code {
197197
h1 { font-size: 1.5rem; }
198198
.badges img { height: 18px; }
199199
}
200+
201+
pre, code {
202+
background: #2d2d2d !important;
203+
color: #eee !important;
204+
border-radius: 6px;
205+
}
206+
207+
pre {
208+
padding: 12px !important;
209+
overflow-x: auto;
210+
}
211+
212+
pre span {
213+
background: none !important;
214+
color: inherit !important;
215+
}

docs/_templates/index.html

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -68,14 +68,15 @@ <h2 id="quick-start">⚡ Quick Start</h2>
6868
<p><strong>⚠️ WARNING — Reproducibility</strong></p>
6969

7070
<p>
71-
vLLM i HuggingFace Transformers mogą dawać <strong>różne wyniki</strong> nawet przy tych samych
72-
ustawieniach (np. temperature=0). Wynika to z różnic w implementacji, precyzji obliczeń i sposobie batchowania.
71+
vLLM and HuggingFace Transformers may produce <strong>different results</strong> even with the same
72+
settings (e.g., temperature=0). This is due to differences in implementation, computation precision,
73+
and batching mechanisms.
7374
</p>
7475

75-
<p><strong>Zalecenie:</strong> do porównywania jakości modeli używaj <strong>tego samego backendu</strong>
76-
(albo tylko vLLM, albo tylko Transformers).</p>
76+
<p><strong>Recommendation:</strong> when comparing model quality, use the <strong>same backend</strong>
77+
(either only vLLM or only Transformers).</p>
7778

78-
<p><strong>Źródła:</strong><br/>
79+
<p><strong>Sources:</strong><br/>
7980
• vLLM FAQ:
8081
<a href="https://docs.vllm.ai/en/latest/usage/faq/" target="_blank">FAQ</a><br/>
8182
• Model Support Policy:
@@ -84,6 +85,7 @@ <h2 id="quick-start">⚡ Quick Start</h2>
8485
</a>
8586
</p>
8687
</div>
88+
8789
<h3>Installation</h3>
8890
<pre><code>pip3 install llmsql</code></pre>
8991

0 commit comments

Comments
 (0)