Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@jcmgray
jcmgray committed Dec 9, 2023
1 parent e8719e3 commit aaa02ab
Show file tree
Hide file tree
Showing 19 changed files with 15,167 additions and 9,079 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/tests.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
env: base

steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4

- name: Install micromamba
uses: mamba-org/setup-micromamba@v1
Expand Down
1 change: 1 addition & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,6 @@ target/
dask-worker-space/

docs/_autosummary/
docs/autoapi

\.vscode/
0 readthedocs.yml → .readthedocs.yml
View file
File renamed without changes.
118 changes: 118 additions & 0 deletions docs/_pygments/_pygments_dark.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# -*- coding: utf-8 -*-
"""
Pygments version of the sublime Mariana theme.
Pygments template by Jan T. Sott (https://github.com/idleberg)
"""

from pygments.style import Style
from pygments.token import Keyword, Name, Comment, String, Error, Text, \
Number, Operator, Generic, Whitespace, Punctuation, Other, Literal


BACKGROUND = "#1a1c1e"
CURRENT_LINE = "#4e5a65"
SELECTION = "#343d46"
FOREGROUND = "#d8dee9"
COMMENT = "#5a6272"
RED = "#ec5f66"
ORANGE = "#f9ae58"
YELLOW = "#fac761"
GREEN = "#99c794"
AQUA = "#70c2bb"
BLUE = "#6699cc"
PURPLE = "#c695c6"


class MarianaDark(Style):

default_style = ''

background_color = BACKGROUND
highlight_color = SELECTION

background_color = BACKGROUND
highlight_color = SELECTION

styles = {
# No corresponding class for the following:
Text: FOREGROUND, # class: ''
Whitespace: "", # class: 'w'
Error: RED, # class: 'err'
Other: "", # class 'x'

Comment: COMMENT, # class: 'c'
Comment.Multiline: "", # class: 'cm'
Comment.Preproc: "", # class: 'cp'
Comment.Single: "", # class: 'c1'
Comment.Special: "", # class: 'cs'

Keyword: PURPLE, # class: 'k'
Keyword.Constant: RED, # class: 'kc'
Keyword.Declaration: "", # class: 'kd'
Keyword.Namespace: PURPLE, # class: 'kn'
Keyword.Pseudo: RED, # class: 'kp'
Keyword.Reserved: "", # class: 'kr'
Keyword.Type: YELLOW, # class: 'kt'

Operator: RED, # class: 'o'
Operator.Word: "", # class: 'ow' - like keywords

Punctuation: AQUA, # class: 'p'

Name: FOREGROUND, # class: 'n'
Name.Attribute: BLUE, # class: 'na' - to be revised
Name.Builtin: BLUE, # class: 'nb'
Name.Builtin.Pseudo: RED, # class: 'bp'
Name.Class: ORANGE, # class: 'nc' - to be revised
Name.Constant: RED, # class: 'no' - to be revised
Name.Decorator: AQUA, # class: 'nd' - to be revised
Name.Entity: BLUE, # class: 'ni'
Name.Exception: RED, # class: 'ne'
Name.Function: AQUA, # class: 'nf'
Name.Function.Magic: BLUE, # class: 'nf'
Name.Property: BLUE, # class: 'py'
Name.Label: BLUE, # class: 'nl'
Name.Namespace: BLUE, # class: 'nn' - to be revised
Name.Other: BLUE, # class: 'nx'
Name.Tag: AQUA, # class: 'nt' - like a keyword
Name.Variable: RED, # class: 'nv' - to be revised
Name.Variable.Class: "", # class: 'vc' - to be revised
Name.Variable.Global: "", # class: 'vg' - to be revised
Name.Variable.Instance: "", # class: 'vi' - to be revised

Number: ORANGE, # class: 'm'
Number.Float: "", # class: 'mf'
Number.Hex: "", # class: 'mh'
Number.Integer: "", # class: 'mi'
Number.Integer.Long: "", # class: 'il'
Number.Oct: "", # class: 'mo'

Literal: ORANGE, # class: 'l'
Literal.Date: GREEN, # class: 'ld'

String: GREEN, # class: 's'
String.Backtick: "", # class: 'sb'
String.Char: FOREGROUND, # class: 'sc'
String.Doc: COMMENT, # class: 'sd' - like a comment
String.Double: "", # class: 's2'
String.Escape: ORANGE, # class: 'se'
String.Heredoc: "", # class: 'sh'
String.Interpol: ORANGE, # class: 'si'
String.Other: "", # class: 'sx'
String.Regex: "", # class: 'sr'
String.Single: "", # class: 's1'
String.Symbol: "", # class: 'ss'

Generic: "", # class: 'g'
Generic.Deleted: RED, # class: 'gd',
Generic.Emph: "italic", # class: 'ge'
Generic.Error: "", # class: 'gr'
Generic.Heading: "bold " + FOREGROUND, # class: 'gh'
Generic.Inserted: GREEN, # class: 'gi'
Generic.Output: "", # class: 'go'
Generic.Prompt: "bold " + COMMENT, # class: 'gp'
Generic.Strong: "bold", # class: 'gs'
Generic.Subheading: "bold " + AQUA, # class: 'gu'
Generic.Traceback: "", # class: 'gt'
}
118 changes: 118 additions & 0 deletions docs/_pygments/_pygments_light.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
# -*- coding: utf-8 -*-
"""
Pygments (light) version of the sublime Mariana theme.
Pygments template by Jan T. Sott (https://github.com/idleberg)
"""

from pygments.style import Style
from pygments.token import Keyword, Name, Comment, String, Error, Text, \
Number, Operator, Generic, Whitespace, Punctuation, Other, Literal


BACKGROUND = "#f8f9fb"
CURRENT_LINE = "#b7c0c8"
SELECTION = "#d0d6dc"
FOREGROUND = "#161c27"
COMMENT = "#8d95a5"
RED = "#e7323b"
ORANGE = "#f79626"
YELLOW = "#f9b52f"
GREEN = "#70b069"
AQUA = "#3d8f88"
BLUE = "#407fbf"
PURPLE = "#b474b4"


class MarianaLight(Style):

default_style = ''

background_color = BACKGROUND
highlight_color = SELECTION

background_color = BACKGROUND
highlight_color = SELECTION

styles = {
# No corresponding class for the following:
Text: FOREGROUND, # class: ''
Whitespace: "", # class: 'w'
Error: RED, # class: 'err'
Other: "", # class 'x'

Comment: COMMENT, # class: 'c'
Comment.Multiline: "", # class: 'cm'
Comment.Preproc: "", # class: 'cp'
Comment.Single: "", # class: 'c1'
Comment.Special: "", # class: 'cs'

Keyword: PURPLE, # class: 'k'
Keyword.Constant: RED, # class: 'kc'
Keyword.Declaration: "", # class: 'kd'
Keyword.Namespace: PURPLE, # class: 'kn'
Keyword.Pseudo: RED, # class: 'kp'
Keyword.Reserved: "", # class: 'kr'
Keyword.Type: YELLOW, # class: 'kt'

Operator: RED, # class: 'o'
Operator.Word: "", # class: 'ow' - like keywords

Punctuation: AQUA, # class: 'p'

Name: FOREGROUND, # class: 'n'
Name.Attribute: BLUE, # class: 'na' - to be revised
Name.Builtin: BLUE, # class: 'nb'
Name.Builtin.Pseudo: RED, # class: 'bp'
Name.Class: ORANGE, # class: 'nc' - to be revised
Name.Constant: RED, # class: 'no' - to be revised
Name.Decorator: AQUA, # class: 'nd' - to be revised
Name.Entity: BLUE, # class: 'ni'
Name.Exception: RED, # class: 'ne'
Name.Function: AQUA, # class: 'nf'
Name.Function.Magic: BLUE, # class: 'nf'
Name.Property: BLUE, # class: 'py'
Name.Label: BLUE, # class: 'nl'
Name.Namespace: BLUE, # class: 'nn' - to be revised
Name.Other: BLUE, # class: 'nx'
Name.Tag: AQUA, # class: 'nt' - like a keyword
Name.Variable: RED, # class: 'nv' - to be revised
Name.Variable.Class: "", # class: 'vc' - to be revised
Name.Variable.Global: "", # class: 'vg' - to be revised
Name.Variable.Instance: "", # class: 'vi' - to be revised

Number: ORANGE, # class: 'm'
Number.Float: "", # class: 'mf'
Number.Hex: "", # class: 'mh'
Number.Integer: "", # class: 'mi'
Number.Integer.Long: "", # class: 'il'
Number.Oct: "", # class: 'mo'

Literal: ORANGE, # class: 'l'
Literal.Date: GREEN, # class: 'ld'

String: GREEN, # class: 's'
String.Backtick: "", # class: 'sb'
String.Char: FOREGROUND, # class: 'sc'
String.Doc: COMMENT, # class: 'sd' - like a comment
String.Double: "", # class: 's2'
String.Escape: ORANGE, # class: 'se'
String.Heredoc: "", # class: 'sh'
String.Interpol: ORANGE, # class: 'si'
String.Other: "", # class: 'sx'
String.Regex: "", # class: 'sr'
String.Single: "", # class: 's1'
String.Symbol: "", # class: 'ss'

Generic: "", # class: 'g'
Generic.Deleted: RED, # class: 'gd',
Generic.Emph: "italic", # class: 'ge'
Generic.Error: "", # class: 'gr'
Generic.Heading: "bold " + FOREGROUND, # class: 'gh'
Generic.Inserted: GREEN, # class: 'gi'
Generic.Output: "", # class: 'go'
Generic.Prompt: "bold " + COMMENT, # class: 'gp'
Generic.Strong: "bold", # class: 'gs'
Generic.Subheading: "bold " + AQUA, # class: 'gu'
Generic.Traceback: "", # class: 'gt'
}
70 changes: 52 additions & 18 deletions docs/_static/my-styles.css
View file
Original file line number Diff line number Diff line change
@@ -1,39 +1,73 @@
@import url('https://fonts.googleapis.com/css2?family=Atkinson+Hyperlegible:ital,wght@0,400;0,700;1,400;1,700&family=IBM+Plex+Mono:ital,wght@0,400;0,600;1,400;1,600&display=swap');

code {
color: #039bea !important;
background-color: #f1fcff !important;
h1, h2, h3 {
font-family: 'IBM Plex Mono', monospace;
font-weight: bold;
}

:root{
--headercolor: #1a5777;
--highlightcolor: #1a5777;
h1 {
font-size: 2.0rem;
}

h1, h2, h3 {
font-family: 'IBM Plex Mono', monospace;
font-weight: bold;
color: var(--headercolor) !important;
h2 {
font-size: 1.75rem;
}

h3 {
font-size: 1.5rem;
}

/* .toctree-l2 {
font-size: 0.85rem;
} */

body {
font-family: 'Atkinson Hyperlegible', sans-serif;
}

/* article {
font-size: 0.9rem;
} */

code, kbd, pre, samp {
font-family: 'IBM Plex Mono', monospace;
}
/*
code.literal {
color: hsl(191, 85%, 50%);
} */

div.cell div.cell_input {
padding-left: 0em;
padding-right: 0em;
border: 1px rgba(127, 127, 127, 0.1) solid;
background-color: rgba(127, 127, 127, 0.1);
border-left-color: green;
border-left-width: medium;
}

.content {
width: 60em;
.cell_output .output.text_plain, .cell_output .output.traceback, .cell_output .output.stream {
border: 1px solid rgba(127, 127, 127, 0.0);
background: rgba(127, 127, 127, 0.0);
margin-top: 0em;
margin-bottom: 0em;
margin-left: 0.5em;
box-shadow: none;
}

.bd-sidebar {
padding-top: 0em;
padding-right: 2em;
padding-left: 2em;
.cell_output .output.stderr {
border: 1px solid rgba(127, 127, 127, 0.0);
background: rgba(127, 127, 127, 0.0);
margin-top: 0em;
margin-bottom: 0em;
margin-left: 0.25em;
box-shadow: none;
border-left-color: #cc7766;
border-left-width: medium;
}

#site-navigation div.navbar_extra_footer {
font-size: .6em;
.cell_output {
padding-left: 1em;
padding-right: 0em;
margin-top: 0em;
}
Loading

0 comments on commit aaa02ab

Please sign in to comment.