Skip to content

Update website, change to new logo #144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 28 commits into from
Jun 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
c7b1927
fix links
SvenKlaassen May 31, 2023
78d602a
Update py_double_ml_pension.ipynb
SvenKlaassen May 31, 2023
3780d6b
Merge pull request #140 from DoubleML/s-inrc-dev
SvenKlaassen May 31, 2023
d329376
fix user guide toc and workflow sidebar
FrederikBornemann Jun 2, 2023
6309bb7
fix panels and change colors
FrederikBornemann Jun 2, 2023
0238c23
add new logos and favicon
FrederikBornemann Jun 2, 2023
f4da2c8
Merge branch 'dev' into f-update-fixing
SvenKlaassen Jun 2, 2023
9e08e6f
change depth in guide and remove math expression from resampling
SvenKlaassen Jun 2, 2023
59b9459
add dark mode logo to path
FrederikBornemann Jun 2, 2023
75d699d
change light primary color for better readability
FrederikBornemann Jun 2, 2023
1fbfdc3
Update requirements.txt
SvenKlaassen Jun 2, 2023
4186a4b
Update requirements.txt
SvenKlaassen Jun 5, 2023
dc00a4b
update sphix version and theme header
SvenKlaassen Jun 5, 2023
d87eb6f
fix icon panel background
FrederikBornemann Jun 5, 2023
2ec2cbc
update conf.py and requirements to include sphinx-design
SvenKlaassen Jun 7, 2023
57bf09d
change tabbing in rst files to sphinx-design
SvenKlaassen Jun 7, 2023
eadac38
Update literature.rst
SvenKlaassen Jun 7, 2023
4de9585
Update release.rst
SvenKlaassen Jun 7, 2023
13b166b
add excecuted notebooks to speed up doc generation
SvenKlaassen Jun 7, 2023
45bfb22
fix links in R_double_ml_pipeline.ipynb
SvenKlaassen Jun 7, 2023
9ceb082
update index panels
SvenKlaassen Jun 8, 2023
188e26d
update literature from sphinx_panels to sphinx_design
SvenKlaassen Jun 8, 2023
85d3601
update example sections
SvenKlaassen Jun 8, 2023
932ee58
Merge pull request #141 from DoubleML/f-update-fixing
SvenKlaassen Jun 8, 2023
20dd9f0
fix pretest notebook
SvenKlaassen Jun 13, 2023
6531acf
fix links (pipeline notebook)
SvenKlaassen Jun 13, 2023
8b9124b
clear CATE notebook to generate plotly graph
SvenKlaassen Jun 13, 2023
e62abb6
Merge pull request #143 from DoubleML/s-inrc-dev
SvenKlaassen Jun 13, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions doc/_static/css/custom.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
/* PYDATA THEME */
html[data-theme="dark"] img:not(.only-dark):not(.dark-light) {
filter: brightness(1) contrast(1) !important;
}

html[data-theme="dark"] .bd-content img:not(.only-dark):not(.dark-light) {
background: none !important;
border-radius: 0;
}

html[data-theme="light"] {
--pst-color-primary: #0063BC;
}

html[data-theme="dark"] {
--pst-color-primary: #0092ff;
}

/* BOOTSTRAP */
.card {
background: none !important;
}
Binary file modified doc/_static/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/logo_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions doc/_templates/logo.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
<p class="logo" style="text-align:center;"><a href="{{ pathto(master_doc)|e }}">
<img class="logo" src="{{ pathto('logo.png', 1)|e }}" alt="Logo" width="65%" height="65%">
</a></p>

<script type="text/javascript">
// Change the logo depending on the theme
var logo = document.querySelector('img.logo');
var observer = new MutationObserver(function(mutations) {
const dark = document.documentElement.dataset.theme == 'dark';
if (dark) {
logo.src = "{{ pathto('logo_dark.png', 1)|e }}";
} else {
logo.src = "{{ pathto('logo.png', 1)|e }}";
}
});
observer.observe(document.documentElement, {attributes: true, attributeFilter: ['data-theme']});
</script>
59 changes: 3 additions & 56 deletions doc/_templates/sidebar-doubleml-workflow.html
Original file line number Diff line number Diff line change
@@ -1,58 +1,5 @@
<style>

.toc-entry {
list-style: none;
margin-left: 0em;
min-height: 50px;
border-left: 2px solid rgba(var(--pst-color-text-base), 1);
padding: 0 0 50px 0px;
position: relative;
}
.toc-entry:last-child{
border-left: 0;
left: 2px;
}

.toc-entry::after{
border-left: 0;
position: absolute;
left: -8px;
top: 0px;
content: " ";
border: 2px solid rgba(255, 255, 255, 1);
border-radius: 500%;
background: rgba(var(--pst-color-toc-link-active), 1);
height: 15px;
width: 15px;
}

.toc-entry:hover::after {
background: rgba(var(--pst-color-link-hover), 1);
transition: all 200ms ease-in-out;
}

.toc-entry > .nav-link {
position: relative;
font-size: small;
font-weight: 600;
text-align: left;
margin: 0;
top: -5px;
color: rgba(var(--pst-color-text-base), 1);
}

.toc-entry > .nav-link.active {
color: rgba(255, 255, 255, 1);
font-size: medium;
background-color: rgba(var(--pst-color-toc-link-active), 1);
border-bottom-right-radius: 20px;
border-top-right-radius: 20px;
border-left: 0;
margin-left: 2px;
padding-right: 15px;
top: -7px;
transition: background-color 200ms ease-in-out, color 200ms ease-in-out, border 200ms ease-in-out, font-size 200ms ease-in-out;
}

.toc-entry {
padding-top: 0.5em;
}
</style>

2 changes: 2 additions & 0 deletions doc/api/api.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _python_api:

API reference
=============

Expand Down
48 changes: 34 additions & 14 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@
'nbsphinx',
'sphinx_gallery.load_style',
'sphinx_copybutton',
'sphinx_panels',
'sphinx_design',
'jupyter_sphinx',
]

Expand Down Expand Up @@ -72,10 +72,11 @@
html_theme_options = {
'github_url': 'https://github.com/DoubleML/doubleml-for-py',
'navigation_with_keys': False,
"header_links_before_dropdown": 6,
}

# html_logo = '../img/logo.png'
html_extra_path = ['../img/logo.png']
html_extra_path = ['../img/logo.png', '../img/logo_dark.png']
html_favicon = '../img/favicon.ico'

html_sidebars = {'**': ['logo.html',
Expand All @@ -93,6 +94,7 @@
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_css_files = ['css/custom.css']

# -- Extension configuration -------------------------------------------------

Expand Down Expand Up @@ -125,18 +127,36 @@
}

linkcheck_ignore = [
'https://doi.org/10.1093/ectj/utaa001', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1111/ectj.12097', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.2307/2171802', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.2307/1912705', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1093/ectj/utaa027', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1111/rssb.12026', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1111/rssa.12623', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1146/annurev-economics-012315-015826', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1109/TIT.2014.2343629', # Valid DOI, Causes 418 Client Error: unknown for url:...
'https://doi.org/10.1093/ectj/utaa001', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1111/0034-6527.00321', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1016/j.jeconom.2020.06.003', # Valid DOI; Causes 403 Client Error: Forbidden for url:...
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1093/ectj/utaa001',
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1111/ectj.12097',
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.2307/2171802',
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.2307/1912705',
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1093/ectj/utaa027',
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1111/rssb.12026',
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1111/rssa.12623',
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1146/annurev-economics-012315-015826',
# Valid DOI, Causes 418 Client Error: unknown for url:...
'https://doi.org/10.1109/TIT.2014.2343629',
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1093/ectj/utaa001',
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1111/0034-6527.00321',
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1016/j.jeconom.2020.06.003',
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1080/07350015.2021.1895815',
# Valid DOI; Causes 403 Client Error: Forbidden for url:...
'https://doi.org/10.1198/jbes.2010.07136',
# Pipelines notebook has to be reworked
'https://mlr3book.mlr-org.com/pipelines.html',
]

# To execute R code via jupyter-execute one needs to install the R kernel for jupyter
Expand Down
917 changes: 830 additions & 87 deletions doc/examples/R_double_ml_pension.ipynb

Large diffs are not rendered by default.

Loading