Skip to content

Commit 9574500

Browse files
jlwalke2jlwalke2
committed
Merge remote-tracking branch 'origin/refactorPZMM' into refactorPZMM
# Conflicts: # src/sasctl/tasks.py # tests/unit/test_model_info.py
2 parents 80d4f0c + 34c41e1 commit 9574500

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+16022
-505
lines changed

‎.github/workflows/build-test-deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ jobs:
104104
run: |
105105
mv doc docs
106106
sudo apt-get install build-essential
107-
pip install sphinx six pyyaml pandas
107+
pip install sphinx six pyyaml pandas pydata-sphinx-theme
108108
109109
- name: Check documentation
110110
uses: ammaraskar/sphinx-problem-matcher@master

‎doc/_static/sas_logo.svg

Lines changed: 27 additions & 0 deletions
Loading

‎doc/_static/sasctl.css

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
@import url('https://fonts.googleapis.com/css2?family=Lato:ital,wght@0,400;0,700;0,900;1,400;1,700;1,900&family=Open+Sans:ital,wght@0,400;0,600;1,400;1,600&display=swap');
2+
3+
.navbar-brand img {
4+
height: 75px;
5+
}
6+
.navbar-brand {
7+
height: 75px;
8+
}
9+
10+
body {
11+
font-family: 'Open Sans', sans-serif;
12+
}
13+
14+
pre, code {
15+
font-size: 100%;
16+
line-height: 155%;
17+
}
18+
19+
h1 {
20+
font-family: "Lato", sans-serif;
21+
color: #013243; /* warm black */
22+
}
23+
24+
h2 {
25+
color: #4d77cf; /* han blue */
26+
letter-spacing: -.03em;
27+
}
28+
29+
h3 {
30+
color: #013243; /* warm black */
31+
letter-spacing: -.03em;
32+
}
33+
34+
/* Style the active version button.
35+
36+
- dev: orange
37+
- stable: green
38+
- old, PR: red
39+
40+
Colors from:
41+
42+
Wong, B. Points of view: Color blindness.
43+
Nat Methods 8, 441 (2011). https://doi.org/10.1038/nmeth.1618
44+
*/
45+
46+
/* If the active version has the name "dev", style it orange */
47+
#version_switcher_button[data-active-version-name*="dev"] {
48+
background-color: #E69F00;
49+
border-color: #E69F00;
50+
color:#000000;
51+
}
52+
53+
/* green for `stable` */
54+
#version_switcher_button[data-active-version-name*="stable"] {
55+
background-color: #009E73;
56+
border-color: #009E73;
57+
}
58+
59+
/* red for `old` */
60+
#version_switcher_button:not([data-active-version-name*="stable"], [data-active-version-name*="dev"], [data-active-version-name=""]) {
61+
background-color: #980F0F;
62+
border-color: #980F0F;
63+
}
64+
65+
/* Main page overview cards */
66+
67+
.sd-card {
68+
background: #fff;
69+
border-radius: 0;
70+
padding: 30px 10px 20px 10px;
71+
margin: 10px 0px;
72+
}
73+
74+
.sd-card .sd-card-header {
75+
text-align: center;
76+
}
77+
78+
.sd-card .sd-card-header .sd-card-text {
79+
margin: 0px;
80+
}
81+
82+
.sd-card .sd-card-img-top {
83+
height: 52px;
84+
width: 52px;
85+
margin-left: auto;
86+
margin-right: auto;
87+
}
88+
89+
.sd-card .sd-card-header {
90+
border: none;
91+
background-color: white;
92+
color: #150458 !important;
93+
font-size: var(--pst-font-size-h5);
94+
font-weight: bold;
95+
padding: 2.5rem 0rem 0.5rem 0rem;
96+
}
97+
98+
.sd-card .sd-card-footer {
99+
border: none;
100+
background-color: white;
101+
}
102+
103+
.sd-card .sd-card-footer .sd-card-text {
104+
max-width: 220px;
105+
margin-left: auto;
106+
margin-right: auto;
107+
}
108+
109+
/* Dark theme tweaking */
110+
html[data-theme=dark] .sd-card img[src*='.svg'] {
111+
filter: invert(0.82) brightness(0.8) contrast(1.2);
112+
}
113+
114+
/* Main index page overview cards */
115+
html[data-theme=dark] .sd-card {
116+
background-color:var(--pst-color-background);
117+
}
118+
119+
html[data-theme=dark] .sd-shadow-sm {
120+
box-shadow: 0 .1rem 1rem rgba(250, 250, 250, .6) !important
121+
}
122+
123+
html[data-theme=dark] .sd-card .sd-card-header {
124+
background-color:var(--pst-color-background);
125+
color: #150458 !important;
126+
}
127+
128+
html[data-theme=dark] .sd-card .sd-card-footer {
129+
background-color:var(--pst-color-background);
130+
}
131+
132+
html[data-theme=dark] h1 {
133+
color: var(--pst-color-primary);
134+
}
135+
136+
html[data-theme=dark] h3 {
137+
color: #0a6774;
138+
}

‎doc/_templates/autosummary/attribute.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:orphan:
2+
3+
{{ fullname | escape | underline}}
4+
5+
.. currentmodule:: {{ module }}
6+
7+
attribute
8+
9+
.. auto{{ objtype }}:: {{ fullname | replace("numpy.", "numpy::") }}
10+
11+
{# In the fullname (e.g. `numpy.ma.MaskedArray.methodname`), the module name
12+
is ambiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`)
13+
specifies `numpy` as the module name. #}

‎doc/_templates/autosummary/base.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{% if objtype == 'property' %}
2+
:orphan:
3+
{% endif %}
4+
5+
{{ fullname | escape | underline}}
6+
7+
.. currentmodule:: {{ module }}
8+
9+
{% if objtype == 'property' %}
10+
property
11+
{% endif %}
12+
13+
.. auto{{ objtype }}:: {{ fullname | replace("numpy.", "numpy::") }}
14+
15+
{# In the fullname (e.g. `numpy.ma.MaskedArray.methodname`), the module name
16+
is ambiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`)
17+
specifies `numpy` as the module name. #}

‎doc/_templates/autosummary/class.rst

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{% extends "!autosummary/class.rst" %}
2+
3+
{% block methods %}
4+
{% if methods %}
5+
.. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
6+
.. autosummary::
7+
:toctree:
8+
{% for item in all_methods %}
9+
{%- if not item.startswith('_') or item in ['__call__'] %}
10+
{{ name }}.{{ item }}
11+
{%- endif -%}
12+
{%- endfor %}
13+
{% endif %}
14+
{% endblock %}
15+
16+
{% block attributes %}
17+
{% if attributes %}
18+
.. HACK -- the point here is that we don't want this to appear in the output, but the autosummary should still generate the pages.
19+
.. autosummary::
20+
:toctree:
21+
{% for item in all_attributes %}
22+
{%- if not item.startswith('_') %}
23+
{{ name }}.{{ item }}
24+
{%- endif -%}
25+
{%- endfor %}
26+
{% endif %}
27+
{% endblock %}

‎doc/_templates/autosummary/member.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:orphan:
2+
3+
{{ fullname | escape | underline}}
4+
5+
.. currentmodule:: {{ module }}
6+
7+
member
8+
9+
.. auto{{ objtype }}:: {{ fullname | replace("numpy.", "numpy::") }}
10+
11+
{# In the fullname (e.g. `numpy.ma.MaskedArray.methodname`), the module name
12+
is ambiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`)
13+
specifies `numpy` as the module name. #}

‎doc/_templates/autosummary/method.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
:orphan:
2+
3+
{{ fullname | escape | underline}}
4+
5+
.. currentmodule:: {{ module }}
6+
7+
method
8+
9+
.. auto{{ objtype }}:: {{ fullname | replace("numpy.", "numpy::") }}
10+
11+
{# In the fullname (e.g. `numpy.ma.MaskedArray.methodname`), the module name
12+
is ambiguous. Using a `::` separator (e.g. `numpy::ma.MaskedArray.methodname`)
13+
specifies `numpy` as the module name. #}

‎doc/_templates/autosummary/minimal_module.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{{ fullname | escape | underline}}
2+
3+
.. automodule:: {{ fullname }}
4+
5+
{% block docstring %}
6+
{% endblock %}
7+
8+

‎doc/_templates/autosummary/module.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
{% extends "!autosummary/module.rst" %}
2+
3+
{# This file is almost the same as the default, but adds :toctree: to the autosummary directives.
4+
The original can be found at `sphinx/ext/autosummary/templates/autosummary/module.rst`. #}
5+
6+
{% block attributes %}
7+
{% if attributes %}
8+
.. rubric:: Module Attributes
9+
10+
.. autosummary::
11+
:toctree:
12+
{% for item in attributes %}
13+
{{ item }}
14+
{%- endfor %}
15+
{% endif %}
16+
{% endblock %}
17+
18+
{% block functions %}
19+
{% if functions %}
20+
.. rubric:: Functions
21+
22+
.. autosummary::
23+
:toctree:
24+
{% for item in functions %}
25+
{{ item }}
26+
{%- endfor %}
27+
{% endif %}
28+
{% endblock %}
29+
30+
{% block classes %}
31+
{% if classes %}
32+
.. rubric:: Classes
33+
34+
.. autosummary::
35+
:toctree:
36+
{% for item in classes %}
37+
{{ item }}
38+
{%- endfor %}
39+
{% endif %}
40+
{% endblock %}

0 commit comments

Comments
 (0)