Skip to content

Commit c77c681

Browse files
JoaopeukoJoaopeuko
committed
add base for documentation
1 parent db14270 commit c77c681

File tree

5 files changed

+649
-0
lines changed

5 files changed

+649
-0
lines changed

‎docs/extra.css‎

Lines changed: 386 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,386 @@
1+
/* Hide the In [ ]: labels */
2+
div.prompt,
3+
.jp-InputPrompt,
4+
.input_prompt,
5+
.out_prompt_overlay,
6+
.prompt_overlay {
7+
display: none !important;
8+
}
9+
10+
.jp-OutputPrompt.jp-OutputArea-prompt {
11+
all: unset !important;
12+
}
13+
14+
/* For Dark Mode */
15+
[data-md-color-scheme="astral-dark"] .jp-Cell {
16+
background-color: var(--space);
17+
color: var(--white);
18+
border: none !important;
19+
box-shadow: none !important;
20+
}
21+
22+
[data-md-color-scheme="astral-dark"] .jp-CodeMirrorEditor {
23+
background-color: var(--galaxy);
24+
color: var(--white);
25+
border: none !important;
26+
box-shadow: none !important;
27+
}
28+
29+
[data-md-color-scheme="astral-dark"] .jp-InputPrompt {
30+
color: var(--white);
31+
}
32+
33+
[data-md-color-scheme="astral-dark"] .jp-InputArea {
34+
border: none !important;
35+
}
36+
37+
[data-md-color-scheme="astral-dark"] .highlight-ipynb {
38+
background-color: var(--space);
39+
color: var(--white);
40+
}
41+
[data-md-color-scheme="astral-dark"] .clipboard-copy {
42+
color: var(--white);
43+
}
44+
45+
[data-md-color-scheme="astral-dark"] .clipboard-copy-txt {
46+
background-color: var(--comet);
47+
color: var(--white);
48+
}
49+
50+
[data-md-color-scheme="astral-dark"] .jp-OutputArea pre {
51+
color: var(--white) !important;
52+
}
53+
54+
[data-md-color-scheme="astral-dark"] .highlight-ipynb .s2 {
55+
color: var(--radiate) !important;
56+
}
57+
58+
:root {
59+
--black: #0b1a34;
60+
--white: #ffffff;
61+
--radiate: #a7ffeb;
62+
--flare: #0088cc;
63+
--rock: #88a2a6;
64+
--galaxy: #10294e;
65+
--space: #073642;
66+
--comet: #567d8e;
67+
--cosmic: #00c3ff;
68+
--sun: #66ff66;
69+
--electron: #00d4ff;
70+
--aurora: #00ffaa;
71+
--constellation: #0080ff;
72+
--neutron: #ccffee;
73+
--proton: #66d9ff;
74+
--nebula: #99ddff;
75+
--supernova: #b3ffcc;
76+
--starlight: #f0f8ff;
77+
--lunar: #e6faff;
78+
--asteroid: #b2c7d9;
79+
--crater: #d1e6f1;
80+
}
81+
82+
[data-md-color-scheme="astral-light"] {
83+
--md-default-bg-color--dark: var(--black);
84+
--md-primary-fg-color: var(--galaxy);
85+
--md-typeset-a-color: var(--flare);
86+
--md-accent-fg-color: var(--cosmic);
87+
}
88+
89+
[data-md-color-scheme="astral-dark"] {
90+
--md-default-bg-color: var(--galaxy);
91+
--md-default-fg-color: var(--white);
92+
--md-default-fg-color--light: var(--white);
93+
--md-default-fg-color--lighter: var(--white);
94+
--md-primary-fg-color: var(--space);
95+
--md-primary-bg-color: var(--white);
96+
--md-accent-fg-color: var(--cosmic);
97+
98+
--md-typeset-color: var(--white);
99+
--md-typeset-a-color: var(--radiate);
100+
--md-typeset-mark-color: var(--sun);
101+
102+
--md-code-fg-color: var(--white);
103+
--md-code-bg-color: var(--space);
104+
105+
--md-code-hl-comment-color: var(--asteroid);
106+
--md-code-hl-punctuation-color: var(--asteroid);
107+
--md-code-hl-generic-color: var(--supernova);
108+
--md-code-hl-variable-color: var(--starlight);
109+
--md-code-hl-string-color: var(--radiate);
110+
--md-code-hl-keyword-color: var(--supernova);
111+
--md-code-hl-operator-color: var(--supernova);
112+
--md-code-hl-number-color: var(--electron);
113+
--md-code-hl-special-color: var(--electron);
114+
--md-code-hl-function-color: var(--neutron);
115+
--md-code-hl-constant-color: var(--radiate);
116+
--md-code-hl-name-color: var(--md-code-fg-color);
117+
118+
--md-typeset-del-color: hsla(6, 90%, 60%, 0.15);
119+
--md-typeset-ins-color: hsla(150, 90%, 44%, 0.15);
120+
121+
--md-typeset-table-color: hsla(0, 0%, 100%, 0.12);
122+
--md-typeset-table-color--light: hsla(0, 0%, 100%, 0.035);
123+
}
124+
125+
[data-md-color-scheme="astral-light"] img[src$="#only-dark"],
126+
[data-md-color-scheme="astral-light"] img[src$="#gh-dark-mode-only"] {
127+
display: none; /* Hide dark images in light mode */
128+
}
129+
130+
[data-md-color-scheme="astral-light"] img[src$="#only-light"],
131+
[data-md-color-scheme="astral-light"] img[src$="#gh-light-mode-only"] {
132+
display: inline; /* Show light images in light mode */
133+
}
134+
135+
[data-md-color-scheme="astral-dark"] img[src$="#only-light"],
136+
[data-md-color-scheme="astral-dark"] img[src$="#gh-light-mode-only"] {
137+
display: none; /* Hide light images in dark mode */
138+
}
139+
140+
[data-md-color-scheme="astral-dark"] img[src$="#only-dark"],
141+
[data-md-color-scheme="astral-dark"] img[src$="#gh-dark-mode-only"] {
142+
display: inline; /* Show dark images in dark mode */
143+
}
144+
145+
/* See: https://github.com/squidfunk/mkdocs-material/issues/175#issuecomment-616694465 */
146+
.md-typeset__table {
147+
min-width: 100%;
148+
}
149+
.md-typeset table:not([class]) {
150+
display: table;
151+
}
152+
153+
/* See: https://github.com/astral-sh/ruff/issues/8519 */
154+
[data-md-color-scheme="astral-dark"] details summary a {
155+
color: var(--flare);
156+
}
157+
158+
/* See: https://github.com/astral-sh/ruff/issues/9046 */
159+
[data-md-color-scheme="astral-dark"] div.admonition {
160+
color: var(--md-code-fg-color);
161+
background-color: var(--md-code-bg-color);
162+
}
163+
164+
/* Prevent the shadow from the nav title from blurring the top link.
165+
The box shadow isn't really doing anything anyway.
166+
167+
This is a consequence of the reduced nav spacing below. */
168+
.md-nav--primary .md-nav__title {
169+
box-shadow: none;
170+
}
171+
172+
/* Omits the nav title "uv" entirely unless on a small screen, in which case
173+
the nav title is needed for backwards navigation in the collapsible
174+
nav variant.
175+
176+
See https://github.com/astral-sh/uv/issues/5130 */
177+
.md-nav__title {
178+
display: none;
179+
}
180+
@media screen and (max-width: 1219px) {
181+
.md-nav__title {
182+
display: flex;
183+
}
184+
}
185+
186+
/* Reducing spacing between nav items to fit more content */
187+
.md-nav__link {
188+
margin-top: 0.25em;
189+
}
190+
.md-nav__item--section {
191+
margin: 0.75em 0;
192+
}
193+
/* Retain larger spacing for each top-level section in the nav */
194+
.md-nav__item--nested {
195+
margin-top: 1em;
196+
}
197+
/* Retain larger spacing for the right-side table-of-contents nav */
198+
.md-nav--secondary .md-nav__link {
199+
margin-top: 0.5em;
200+
}
201+
/* See: https://mkdocstrings.github.io/recipes/#prevent-selection-of-prompts-and-output-in-python-code-blocks */
202+
.highlight .gp,
203+
.highlight .go {
204+
/* Generic.Prompt, Generic.Output */
205+
user-select: none;
206+
}
207+
208+
/* Increase the size of the sections headings, remove the bold */
209+
.md-nav__container > .md-nav__link:first-child {
210+
font-size: 17.5px;
211+
font-weight: normal;
212+
margin-bottom: 0.1em;
213+
}
214+
215+
/* Increase the size of the index nav item to match the sections */
216+
.md-nav__item:first-child {
217+
font-size: 17.5px;
218+
font-weight: normal;
219+
}
220+
/* But do not increase the size of other nav items */
221+
.md-nav__item--section > .md-nav > .md-nav__list > .md-nav__item {
222+
font-size: 15px;
223+
font-weight: normal;
224+
}
225+
226+
/* Bold the active nav link for accessibility */
227+
.md-nav__link--active {
228+
font-weight: bold;
229+
}
230+
231+
/* Styling for the generated CLI reference page */
232+
.cli-reference dd {
233+
margin-top: 0.1em;
234+
margin-bottom: 0.5em;
235+
}
236+
.cli-reference dd p {
237+
margin-block-start: 0.2em;
238+
margin-block-end: 0.3em;
239+
}
240+
.cli-reference ul {
241+
margin-bottom: 0.1em;
242+
}
243+
h3.cli-reference {
244+
font-size: 1.1em;
245+
margin: 0 0 0 0;
246+
}
247+
248+
/* Adjust font size and weight for better readability */
249+
.md-nav__title,
250+
.md-nav__link {
251+
font-size: 14px;
252+
font-weight: 500;
253+
}
254+
255+
/* Improve indentation and spacing */
256+
.md-nav__list {
257+
padding-left: 10px;
258+
}
259+
260+
.md-nav__item {
261+
margin-bottom: 2px;
262+
}
263+
264+
/* Adjust the styling for nested elements */
265+
.md-nav__item .md-nav__list {
266+
padding-left: 15px;
267+
font-size: 13px;
268+
}
269+
270+
/* Improve hover effect */
271+
.md-nav__link:hover {
272+
color: #007bff; /* Adjust the color as needed */
273+
font-weight: 600;
274+
}
275+
276+
/* Fix inconsistent line height */
277+
.md-nav__list,
278+
.md-nav__item {
279+
line-height: 1.5;
280+
}
281+
282+
/* Adjust spacing between menu items */
283+
.md-nav__list {
284+
margin-bottom: 5px;
285+
}
286+
287+
/* Improve property display */
288+
.doc-property {
289+
margin-bottom: 1.5rem;
290+
border-left: 3px solid var(--md-primary-fg-color);
291+
padding-left: 1rem;
292+
background-color: rgba(0, 0, 0, 0.03);
293+
padding: 0.5rem 1rem;
294+
border-radius: 0.2rem;
295+
}
296+
297+
.doc-property .doc-label {
298+
font-size: 1.1rem;
299+
font-weight: 600;
300+
color: var(--md-primary-fg-color);
301+
margin-bottom: 0.5rem;
302+
font-family: var(--md-code-font-family);
303+
}
304+
305+
.doc-property .doc-object-name {
306+
font-weight: normal;
307+
font-size: 1rem;
308+
margin-left: 0.5rem;
309+
}
310+
311+
/* Improve hierarchy with indentation */
312+
.doc-class {
313+
margin-left: 0;
314+
}
315+
316+
.doc-class .doc-contents {
317+
margin-left: 1rem;
318+
border-left: 1px solid rgba(0, 0, 0, 0.1);
319+
padding-left: 1rem;
320+
}
321+
322+
.doc-method, .doc-function, .doc-attribute, .doc-property {
323+
margin-left: 1rem;
324+
}
325+
326+
/* Improve headings */
327+
.doc h1.doc-heading {
328+
font-size: 2rem;
329+
margin-bottom: 1.5rem;
330+
padding-bottom: 0.3rem;
331+
border-bottom: 1px solid rgba(0, 0, 0, 0.1);
332+
}
333+
334+
.doc h2.doc-heading {
335+
font-size: 1.5rem;
336+
margin-top: 2rem;
337+
margin-bottom: 1rem;
338+
padding-bottom: 0.2rem;
339+
border-bottom: 1px solid rgba(0, 0, 0, 0.05);
340+
}
341+
342+
.doc h3.doc-heading, .doc h4.doc-heading {
343+
font-size: 1.2rem;
344+
margin-top: 1.5rem;
345+
margin-bottom: 0.75rem;
346+
}
347+
348+
/* Property value styling */
349+
.doc-property .doc p {
350+
margin: 0.5rem 0;
351+
}
352+
353+
/* Hide repetitive property text */
354+
.doc-property .doc-label .doc-annotation {
355+
font-size: 0.8rem;
356+
opacity: 0.6;
357+
font-weight: normal;
358+
}
359+
360+
/* Better display for copy buttons */
361+
.doc-contents .doc-function .md-clipboard,
362+
.doc-contents .doc-method .md-clipboard,
363+
.doc-contents .doc-class .md-clipboard,
364+
.doc-contents .doc-property .md-clipboard {
365+
color: rgba(0, 0, 0, 0.3);
366+
}
367+
368+
.doc-contents .doc-function .md-clipboard:hover,
369+
.doc-contents .doc-method .md-clipboard:hover,
370+
.doc-contents .doc-class .md-clipboard:hover,
371+
.doc-contents .doc-property .md-clipboard:hover {
372+
color: var(--md-primary-fg-color);
373+
}
374+
375+
/* Hide module h1 headers */
376+
.doc-module > h1.doc-heading {
377+
display: none !important;
378+
}
379+
380+
/* Hide all first h1 headers - typically module names */
381+
h1:first-of-type {
382+
display: none !important;
383+
}
384+
body > div.md-container > main > div > div.md-sidebar.md-sidebar--secondary > div > div > nav > ul > li:nth-child(1) > a > span {
385+
display: none !important;
386+
}

0 commit comments

Comments
 (0)