Skip to content

Commit 9f594b5

Browse files
committed
[DOC] change landing-page + installation
1 parent 824072a commit 9f594b5

4 files changed

Lines changed: 50 additions & 47 deletions

File tree

docs/source/_static/css/custom.css

Lines changed: 23 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
/* Custom CSS for Hyperactive documentation */
22
/* Purple/Violet theme matching the Hyperactive logo */
33

4+
/* ============================================
5+
Google Font Import for Hero Title
6+
============================================ */
7+
@import url('https://fonts.googleapis.com/css2?family=Outfit:wght@600;700&display=swap');
8+
49
/* ============================================
510
CSS Variables for consistent theming
611
============================================ */
@@ -11,8 +16,8 @@
1116
--hyperactive-accent: #8080B0;
1217
--hyperactive-dark: #4A4A65;
1318
--hyperactive-light: #f8f9fa;
14-
--hyperactive-gradient: linear-gradient(135deg, #5D5D7A 0%, #8080B0 100%);
15-
--hyperactive-gradient-dark: linear-gradient(135deg, #4A4A65 0%, #6B6B8E 100%);
19+
--hyperactive-gradient: linear-gradient(135deg, #3D3D55 0%, #5858A0 100%);
20+
--hyperactive-gradient-dark: linear-gradient(135deg, #2D2D45 0%, #484890 100%);
1621
--card-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px rgba(0, 0, 0, 0.06);
1722
--card-shadow-hover: 0 20px 25px -5px rgba(0, 0, 0, 0.1), 0 10px 10px -5px rgba(0, 0, 0, 0.04);
1823
/* Neutral separator color */
@@ -54,11 +59,14 @@ html[data-theme="dark"] {
5459
z-index: 1;
5560
}
5661

57-
.hero-logo {
58-
max-width: 200px;
59-
height: auto;
60-
margin-bottom: 1.5rem;
61-
filter: drop-shadow(0 4px 8px rgba(0, 0, 0, 0.2));
62+
.hero-title {
63+
font-family: 'Outfit', -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
64+
font-size: 3.5rem;
65+
font-weight: 700;
66+
color: #ffffff;
67+
margin: 0 0 1rem 0;
68+
letter-spacing: -0.02em;
69+
text-shadow: 0 2px 8px rgba(0, 0, 0, 0.25);
6270
}
6371

6472
.hero-tagline {
@@ -72,22 +80,7 @@ html[data-theme="dark"] {
7280
.hero-subtitle {
7381
font-size: 1.1rem;
7482
color: rgba(255, 255, 255, 0.9);
75-
margin: 0 0 1.5rem 0;
76-
}
77-
78-
.hero-badges {
79-
display: flex;
80-
justify-content: center;
81-
gap: 0.75rem;
82-
flex-wrap: wrap;
83-
}
84-
85-
.hero-badges img {
86-
transition: transform 0.2s ease;
87-
}
88-
89-
.hero-badges img:hover {
90-
transform: translateY(-2px);
83+
margin: 0;
9184
}
9285

9386
/* ============================================
@@ -366,6 +359,10 @@ h2::after {
366359
margin: -1rem -0.5rem 1.5rem -0.5rem;
367360
}
368361

362+
.hero-title {
363+
font-size: 2.5rem;
364+
}
365+
369366
.hero-tagline {
370367
font-size: 1.4rem;
371368
}
@@ -374,10 +371,6 @@ h2::after {
374371
font-size: 1rem;
375372
}
376373

377-
.hero-logo {
378-
max-width: 150px;
379-
}
380-
381374
.maturity-items {
382375
gap: 1rem;
383376
}
@@ -392,9 +385,8 @@ h2::after {
392385
}
393386

394387
@media (max-width: 480px) {
395-
.hero-badges {
396-
flex-direction: column;
397-
align-items: center;
388+
.hero-title {
389+
font-size: 2rem;
398390
}
399391

400392
.maturity-items {
@@ -412,6 +404,7 @@ h2::after {
412404
color: #000 !important;
413405
}
414406

407+
.hero-title,
415408
.hero-tagline,
416409
.hero-subtitle {
417410
color: #000 !important;

docs/source/_templates/layout.html

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{% extends "pydata_sphinx_theme/layout.html" %}
2+
3+
{% block extrahead %}
4+
{{ super() }}
5+
<meta name="python-version-range" content="{{ python_version_range }}">
6+
{% endblock %}

docs/source/conf.py

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,13 @@ def extract_pyproject_metadata():
6969
# Extract metadata once at configuration time
7070
PYPROJECT_METADATA = extract_pyproject_metadata()
7171

72+
# Build Python version range string from metadata
73+
_py_versions = PYPROJECT_METADATA["python_versions"]
74+
if _py_versions:
75+
_py_version_range = f"{_py_versions[0]} - {_py_versions[-1]}"
76+
else:
77+
_py_version_range = "3.10+"
78+
7279
# -- Project information -----------------------------------------------------
7380
current_year = datetime.datetime.now().year
7481
project = "hyperactive"
@@ -238,6 +245,11 @@ def find_source():
238245
"url": "https://github.com/SimonBlanke/Hyperactive",
239246
"icon": "fab fa-github",
240247
},
248+
{
249+
"name": "Star on GitHub",
250+
"url": "https://github.com/SimonBlanke/Hyperactive/stargazers",
251+
"icon": "fa-regular fa-star",
252+
},
241253
],
242254
"show_prev_next": False,
243255
"use_edit_page_button": False,
@@ -254,12 +266,14 @@ def find_source():
254266
"github_repo": "Hyperactive",
255267
"github_version": "master",
256268
"doc_path": "auto-doc/source/",
269+
"python_version_range": _py_version_range,
257270
}
258271

259272
html_sidebars = {
260273
"**": ["sidebar-nav-bs.html"],
261274
"index": [],
262275
"get_started": [],
276+
"installation": [],
263277
"search": [],
264278
}
265279

@@ -366,16 +380,11 @@ def adds(pth):
366380
# -- RST Epilog: Make metadata available as substitutions in RST files -------
367381
# These can be used as |variable_name| in RST files
368382

369-
# Build Python versions list dynamically
370-
_py_versions = PYPROJECT_METADATA["python_versions"]
383+
# Build additional Python versions formatting for RST
371384
if _py_versions:
372-
_py_versions_list = "\n".join(f"- Python {v}" for v in _py_versions)
373385
_py_versions_inline = ", ".join(_py_versions)
374-
_py_version_range = f"{_py_versions[0]} through {_py_versions[-1]}"
375386
else:
376-
_py_versions_list = "- Python 3.10+"
377387
_py_versions_inline = "3.10+"
378-
_py_version_range = "3.10+"
379388

380389
rst_epilog = f"""
381390
.. |version| replace:: {PYPROJECT_METADATA["version"]}

docs/source/index.rst

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,12 @@
44

55
<div class="hero-section">
66
<div class="hero-content">
7-
<img src="_static/images/logo.png" alt="Hyperactive Logo" class="hero-logo" />
7+
<h1 class="hero-title">Hyperactive</h1>
88
<p class="hero-tagline">A unified interface for optimization algorithms and problems</p>
99
<p class="hero-subtitle">Production-ready hyperparameter optimization for machine learning</p>
10-
<div class="hero-badges">
11-
<a href="https://pypi.org/project/hyperactive/"><img src="https://img.shields.io/pypi/v/hyperactive?style=for-the-badge&color=4c9aff" alt="PyPI Version" /></a>
12-
<a href="https://github.com/SimonBlanke/Hyperactive"><img src="https://img.shields.io/github/stars/SimonBlanke/Hyperactive?style=for-the-badge&color=ffd700" alt="GitHub Stars" /></a>
13-
<a href="https://github.com/SimonBlanke/Hyperactive/actions"><img src="https://img.shields.io/github/actions/workflow/status/SimonBlanke/hyperactive/test.yml?style=for-the-badge&logo=github" alt="Build Status" /></a>
14-
</div>
1510
</div>
1611
</div>
1712

18-
==========
19-
Hyperactive
20-
==========
21-
2213
.. raw:: html
2314

2415
<div class="maturity-banner">
@@ -33,14 +24,18 @@ Hyperactive
3324
</div>
3425
<div class="maturity-item">
3526
<span class="maturity-icon">🐍</span>
36-
<span class="maturity-text"><strong>Python 3.10 - 3.14</strong></span>
27+
<span class="maturity-text"><strong>Python <span id="python-version-range"></span></strong></span>
3728
</div>
3829
<div class="maturity-item">
3930
<span class="maturity-icon">📜</span>
4031
<span class="maturity-text"><strong>MIT Licensed</strong></span>
4132
</div>
4233
</div>
4334
</div>
35+
<script>
36+
document.getElementById('python-version-range').textContent =
37+
document.querySelector('meta[name="python-version-range"]').content;
38+
</script>
4439

4540

4641
Hyperactive provides a collection of optimization algorithms, accessible through a unified

0 commit comments

Comments
 (0)