Skip to content

Commit 3e8e6c9

Browse files
docs: update to most recent sphinx template (#20)
1 parent eb601d8 commit 3e8e6c9

9 files changed

Lines changed: 389 additions & 85 deletions

File tree

docs/_static/4insight-logo.svg

Lines changed: 1 addition & 1 deletion
Loading

docs/_static/4subsea-logo.svg

Lines changed: 13 additions & 11 deletions
Loading

docs/_static/css/custom.css

Lines changed: 150 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,21 @@
11
/* Provided by the Sphinx base theme template at build time */
22
@import "../basic.css";
33

4-
/*****************************************************************************
5-
* 4Subsea tweaks
6-
**/
7-
8-
.bd-header.navbar-light#navbar-main .navbar-nav li a.nav-link {
9-
padding: 0 0.5rem;
10-
color: var(--pst-color-navbar-link)
11-
}
12-
13-
14-
.bd-header.navbar-light#navbar-main .navbar-nav li a.nav-link:hover{
15-
color: var(--pst-color-primary)
16-
}
17-
18-
19-
.admonition, div.admonition {
20-
background-color: transparent ;
21-
}
22-
23-
24-
h1, h2 {
25-
color: var(--pst-color-h1);
26-
}
27-
28-
29-
304
:root {
5+
316

327
/*****************************************************************************
338
* Theme config
349
**/
3510
--pst-header-height: 44px;
3611

37-
3812
/*****************************************************************************
3913
* Font size
4014
**/
41-
--pst-font-size-base: 14px; /* base font size - applied at body / html level */
15+
--pst-font-size-base: 18px; /* base font size - applied at body / html level */
16+
--pst-font-size-nav: 15px; /* navbar font size */
17+
--pst-font-size-breadcrumb: 16px; /* breadcrumb font size */
18+
--pst-font-size-logo: 16px; /* breadcrumb font size */
4219

4320
/*****************************************************************************
4421
* Font family
@@ -55,48 +32,173 @@ h1, h2 {
5532
Liberation Mono, "Lucida Console", monospace;
5633

5734
--pst-font-family-base: var(--pst-font-family-sansserif-system);
58-
--pst-font-family-heading: var(--pst-font-family-serif-system);
35+
--pst-font-family-heading: var(--pst-font-family-sansserif-system);
5936
--pst-font-family-monospace: var(--pst-font-family-monospace-system);
6037

6138
/*****************************************************************************
6239
* Color
63-
*
64-
* Colors are defined in rgb string way, "red, green, blue"
6540
**/
41+
--pst-color-on-background: #333333 !important; /*navbar bg-colour*/
42+
--pst-color-background: #ece9e5 !important;
43+
6644
--pst-color-primary: #00A0AF !important; /* headers */
67-
--pst-color-text-base: 0, 45, 86 !important;
45+
--pst-color-text-base: #49494a !important;
6846
--pst-color-info: #009DDC !important;
6947
--pst-color-success: 0, 168, 143;
7048
--pst-color-warning: 250, 166, 52;
7149
--pst-color-danger: 237, 23, 79;
7250

73-
--pst-color-on-background: #333333 !important; /*navbar bg-colour*/
74-
--pst-color-text-muted: #F5F5F5 !important; /* Navbar text and inactive sidebar links*/
75-
--pst-color-text-muted: #77757A !important ;
76-
77-
--pst-color-h1: #002D56 !important;
78-
--pst-color-h2: var(--pst-color-h1);
79-
--pst-color-h3: var(--pst-color-h1);
80-
--pst-color-h4: var(--pst-color-h1);
51+
--pst-color-h1: var(--pst-color-primary) !important;
52+
--pst-color-h2: var(--pst-color-primary) !important;
53+
--pst-color-h3: #49494a !important;
54+
--pst-color-h4: var(--pst-color-primary) !important;
8155
--pst-color-h5: var(--pst-color-text-base);
8256
--pst-color-h6: var(--pst-color-text-base);
8357
--pst-color-paragraph: var(--pst-color-text-base);
84-
--pst-color-link: var(--pst-color-primary) !important; /*links*/
58+
--pst-color-link: #00A0AF !important; /*links*/
8559
--pst-color-link-hover: #F3776F !important;
86-
--pst-color-headerlink: #002D56 !important;;
60+
--pst-color-headerlink: #002D56 !important;
8761
--pst-color-headerlink-hover: #0032FA !important;
8862
--pst-color-inline-code: #ED174F !important;
8963

64+
--pst-color-text-muted: #77757A !important ; /* Navbar text and inactive sidebar links*/
9065

91-
--pst-color-active-navigation: var(--pst-color-primary);
92-
--pst-color-navbar-link: #F5F5F5 !important;
93-
--pst-color-navbar-link-hover: var(--pst-color-active-navigation) !important;
94-
--pst-color-navbar-link-active: var(--pst-color-active-navigation);
95-
66+
--pst-color-active-navigation: red !important; /*#00A0Af !important;*/
67+
--pst-color-navbar-link: #ece9e5 !important;
9668

9769
/*****************************************************************************
9870
* Admonitions
9971
**/
10072
--pst-color-admonition-default: var(--pst-color-info) !important;
10173
--pst-color-admonition-note: var(--pst-color-info) !important;
102-
}
74+
}
75+
76+
/*****************************************************************************
77+
* 4Subsea tweaks
78+
**/
79+
h1, h2 {
80+
color: var(--pst-color-h1);
81+
}
82+
83+
h1 {
84+
font-size: 32px;
85+
}
86+
h2 {
87+
font-size: 22px;
88+
}
89+
90+
h3 {
91+
font-size: 18px;
92+
font-weight: 700;
93+
}
94+
95+
.bd-header {
96+
padding-top: 0px;
97+
padding-bottom: 0px;
98+
justify-content: left;
99+
max-height: var(--pst-header-height);
100+
white-space: nowrap;
101+
}
102+
103+
.bd-header .bd-header__inner{
104+
margin-top: 5px;
105+
}
106+
107+
.bd-header .navbar-nav li {
108+
font-size: var(--pst-font-size-nav);
109+
}
110+
111+
.bd-header .navbar-nav li a.nav-link {
112+
color: var(--pst-color-navbar-link);
113+
}
114+
115+
.bd-header .navbar-nav li a.nav-link:hover {
116+
color: var(--pst-color-navbar-link);
117+
}
118+
119+
.bd-header .navbar-nav:not(#navbar-icon-links) li a.nav-link:hover {
120+
text-decoration: underline;
121+
text-decoration-thickness: 2px;
122+
text-underline-offset: 3px;
123+
text-decoration-color: var(--pst-color-link);
124+
}
125+
126+
.bd-header .navbar-nav>.active>.nav-link {
127+
color: var(--pst-color-navbar-link);
128+
font-weight: 400;
129+
}
130+
131+
.bd-header .navbar-nav .dropdown button {
132+
color: var(--pst-color-navbar-link);
133+
font-size: var(--pst-font-size-nav);
134+
}
135+
136+
.navbar-brand {
137+
margin-left: 73px;
138+
margin-right: 47px;
139+
}
140+
141+
.navbar-brand img{
142+
height: 22px;
143+
}
144+
145+
.navbar-brand img:hover{
146+
height: 32px;
147+
border-top: transparent;
148+
border-top-style: solid;
149+
border-top-width: 2px;
150+
padding-top: 3px;
151+
border-bottom: var(--pst-color-primary);
152+
border-bottom-style: solid;
153+
border-bottom-width: 2px;
154+
padding-bottom: 3px;
155+
}
156+
157+
.logo__title {
158+
color: var(--pst-color-navbar-link);
159+
font-size: var(--pst-font-size-logo);
160+
padding-left: 4px;
161+
}
162+
163+
.admonition, div.admonition {
164+
background-color: transparent ;
165+
}
166+
167+
.tocsection.sourcelink {
168+
display: none;
169+
}
170+
171+
/* Stuff for breadcrumb lists */
172+
.breadcrumb {
173+
height: var(--pst-header-height);
174+
background-color: white;
175+
font-size: var(--pst-font-size-breadcrumb);
176+
padding-left: 16px;
177+
padding-top: 10px;
178+
179+
}
180+
181+
ul.breadcrumb {
182+
list-style: none;
183+
}
184+
185+
.breadcrumb .current_relbar{
186+
color:var(--pst-color-text-base);
187+
}
188+
189+
ul.breadcrumb li {
190+
display: inline;
191+
}
192+
193+
ul.breadcrumb li a:hover {
194+
color: var(--pst-color-link);
195+
text-decoration: underline;
196+
text-decoration-thickness: 1px;
197+
text-underline-offset: 2px;
198+
}
199+
200+
ul.breadcrumb li+li:before {
201+
padding: 5px;
202+
color: var(--pst-color-text-base);
203+
content: "/\00a0";
204+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{{ objname }}
2+
{{ underline }}
3+
4+
5+
6+
.. currentmodule:: {{module}}
7+
8+
.. autoclass:: {{ objname }}
9+
:members:
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{{ objname}}
2+
{{ underline }}
3+
4+
5+
.. currentmodule:: {{module}}
6+
7+
.. autofunction:: {{ objname }}

0 commit comments

Comments
 (0)