Skip to content

Commit 2f54a85

Browse files
committed
Update sphinx docs styling and fix some docstring formatting issues
1 parent 199c87b commit 2f54a85

15 files changed

Lines changed: 584 additions & 67 deletions

File tree

.gitignore

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,4 @@ htmlcov/
5959
dev/
6060

6161
# Sphinx docs output
62-
docs/_build/
63-
docs/_static/
64-
docs/_templates/
62+
docs/_build/

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
[![Tests](https://github.com/katelouie/stellium/actions/workflows/tests.yml/badge.svg)](https://github.com/katelouie/stellium/actions/workflows/tests.yml)
88
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/katelouie/stellium)
99
[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
10-
![Read the Docs](https://img.shields.io/readthedocs/stellium)
10+
<!-- Documentation (if you have docs) -->
11+
[![Documentation Status](https://readthedocs.org/projects/stellium/badge/?version=latest)](https://stellium.readthedocs.io/en/latest/?badge=latest)
1112

1213
**A modern, extensible Python library for computational astrology**
1314

docs/_static/custom.css

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
/* Warm mystical enhancements */
2+
3+
/* Heading font - elegant serif for that mystical feel */
4+
h1,
5+
h2,
6+
h3,
7+
h4,
8+
h5,
9+
h6,
10+
.sidebar-brand-text {
11+
font-family: 'Crimson Pro', 'Georgia', serif;
12+
letter-spacing: 0.02em;
13+
}
14+
15+
/* Add subtle decorative elements to main headings */
16+
.content h1 {
17+
border-bottom: 2px solid #8e6b8a;
18+
padding-bottom: 0.3em;
19+
margin-bottom: 1em;
20+
}
21+
22+
.content h2 {
23+
border-bottom: 1px solid #d4cdc3;
24+
padding-bottom: 0.25em;
25+
margin-top: 1.5em;
26+
}
27+
28+
/* Subtle warm shadow for code blocks */
29+
.highlight {
30+
border-left: 3px solid #8e6b8a;
31+
box-shadow: 0 1px 3px rgba(74, 51, 83, 0.1);
32+
}
33+
34+
/* API documentation styling */
35+
.sig-name {
36+
font-weight: 600;
37+
color: #4a3353;
38+
}
39+
40+
/* Warm glow on hover for links */
41+
a:hover {
42+
text-decoration-color: #b8953d;
43+
}
44+
45+
/* Subtle texture (optional - remove if too much) */
46+
.sidebar-drawer {
47+
background-image:
48+
radial-gradient(circle at 20% 50%, rgba(142, 107, 138, 0.03) 0%, transparent 50%),
49+
radial-gradient(circle at 80% 80%, rgba(74, 51, 83, 0.03) 0%, transparent 50%);
50+
}
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
// Force light mode as default on first visit
2+
(function () {
3+
// Only run if no preference has been set yet
4+
if (!localStorage.getItem('theme')) {
5+
localStorage.setItem('theme', 'light');
6+
document.documentElement.dataset.theme = 'light';
7+
}
8+
})();

0 commit comments

Comments
 (0)