Skip to content

Commit 06f63fd

Browse files
authored
Merge pull request #598 from PyAutoLabs/feature/docs-theming-hub
docs: shared PyAuto brand layer for the Furo docs
2 parents 6a05f4f + 2eba5ab commit 06f63fd

3 files changed

Lines changed: 109 additions & 71 deletions

File tree

.gitignore

Lines changed: 67 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -1,69 +1,68 @@
1-
.envr
2-
*.ipynb
3-
.projprofile
4-
*.pyc
5-
pip-selfcheck.json
6-
.Python
7-
bin/
8-
include/
9-
lib/
10-
.ipynb_checkpoints
11-
.cache
12-
.idea
13-
.env
14-
.pytest_cache
15-
MultiNest/
16-
hyper
17-
hyper_galaxies
18-
files
19-
Nonesubplots
20-
scripts
21-
subplots
22-
test_files
23-
scripts/
24-
subplots/
25-
multinest
26-
.DS_Store
27-
temp.txt
28-
*.log
29-
*.swp
30-
.coverage
31-
dist/
32-
PyAutoLens.egg-info/
33-
autolens.egg-info/
34-
__pycache__/
35-
prof/
36-
config/*.pyc
37-
test/integration/data/
38-
test/output/
39-
test/test_files/plotting/
40-
test/integration/tests/simulate_and_fit/datas/
41-
output
42-
test/integration/datas/
43-
search.py
44-
bfg-1.13.0.jar
45-
error.log
46-
workspace/scraps
47-
workspace_jam/
48-
workspace_amy/
49-
workspace/runners/cosma/
50-
workspace/
51-
test/integration/data_temp/
52-
autolens/lens/lens_fit/__pycache__
53-
test/integration/hyper/
54-
test/integration/image/
55-
test/data/
56-
test/unit/data/test_files/
57-
test_autolens/integration/data_temp/
58-
test_autolens/dataset/
59-
.eggs/
60-
__MACOSX/
61-
62-
#docs
63-
docs/_build
64-
docs/_static
65-
docs/_templates
66-
docs/generated
67-
docs/api/generated
68-
autolens_workspace_test/
1+
.envr
2+
*.ipynb
3+
.projprofile
4+
*.pyc
5+
pip-selfcheck.json
6+
.Python
7+
bin/
8+
include/
9+
lib/
10+
.ipynb_checkpoints
11+
.cache
12+
.idea
13+
.env
14+
.pytest_cache
15+
MultiNest/
16+
hyper
17+
hyper_galaxies
18+
files
19+
Nonesubplots
20+
scripts
21+
subplots
22+
test_files
23+
scripts/
24+
subplots/
25+
multinest
26+
.DS_Store
27+
temp.txt
28+
*.log
29+
*.swp
30+
.coverage
31+
dist/
32+
PyAutoLens.egg-info/
33+
autolens.egg-info/
34+
__pycache__/
35+
prof/
36+
config/*.pyc
37+
test/integration/data/
38+
test/output/
39+
test/test_files/plotting/
40+
test/integration/tests/simulate_and_fit/datas/
41+
output
42+
test/integration/datas/
43+
search.py
44+
bfg-1.13.0.jar
45+
error.log
46+
workspace/scraps
47+
workspace_jam/
48+
workspace_amy/
49+
workspace/runners/cosma/
50+
workspace/
51+
test/integration/data_temp/
52+
autolens/lens/lens_fit/__pycache__
53+
test/integration/hyper/
54+
test/integration/image/
55+
test/data/
56+
test/unit/data/test_files/
57+
test_autolens/integration/data_temp/
58+
test_autolens/dataset/
59+
.eggs/
60+
__MACOSX/
61+
62+
#docs
63+
docs/_build
64+
docs/_templates
65+
docs/generated
66+
docs/api/generated
67+
autolens_workspace_test/
6968
docs/api/_autosummary

docs/_static/pyauto.css

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
/* PyAuto shared docs brand layer — identical file in PyAutoFit, PyAutoGalaxy,
2+
PyAutoLens (docs/_static/pyauto.css). The per-project accent is set via
3+
Furo's color-brand-* variables in each repo's conf.py; this file carries
4+
the elements common to the whole stack. */
5+
6+
/* The PyAuto family signature: a thin gradient strip across the top of every
7+
docs page, running through the three stack accents (Fit / Galaxy / Lens). */
8+
body::before {
9+
content: "";
10+
position: fixed;
11+
top: 0;
12+
left: 0;
13+
right: 0;
14+
height: 3px;
15+
background: linear-gradient(90deg, #c2410c 0%, #0f766e 50%, #7c4dff 100%);
16+
z-index: 1000;
17+
pointer-events: none;
18+
}
19+
@media (prefers-color-scheme: dark) {
20+
body:not([data-theme="light"])::before {
21+
background: linear-gradient(90deg, #f28c38 0%, #2dd4bf 50%, #9d7aff 100%);
22+
}
23+
}
24+
body[data-theme="dark"]::before {
25+
background: linear-gradient(90deg, #f28c38 0%, #2dd4bf 50%, #9d7aff 100%);
26+
}
27+
28+
/* Project wordmark in the sidebar. */
29+
.sidebar-brand-text {
30+
font-weight: 700;
31+
letter-spacing: -0.01em;
32+
}

docs/conf.py

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -124,11 +124,18 @@
124124

125125
language = "en"
126126

127+
html_static_path = ["_static"]
128+
html_css_files = ["pyauto.css"]
129+
127130
html_theme_options = {
128131
"light_css_variables": {
129-
"color-brand-primary": "#7C4DFF",
130-
"color-brand-content": "#7C4DFF",
131-
}
132+
"color-brand-primary": "#7c4dff",
133+
"color-brand-content": "#7c4dff",
134+
},
135+
"dark_css_variables": {
136+
"color-brand-primary": "#9d7aff",
137+
"color-brand-content": "#9d7aff",
138+
},
132139
}
133140

134141
from sphinx.builders.html import StandaloneHTMLBuilder

0 commit comments

Comments
 (0)