Skip to content

Add GDPR to docs footers #165

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add GDPR to docs footers #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 46 additions & 0 deletions docs/source/_static/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
.wy-nav-content {
margin: 0;
background: #fcfcfc;
padding-top: 40px;
}

.wy-side-nav-search {
display: block;
width: 300px;
padding: .809em;
padding-top: 0.809em;
margin-bottom: .809em;
z-index: 200;
background-color: #2980b9;
text-align: center;
color: #fcfcfc;
padding-top: 40px;
}

div.banner {
position: fixed;
top: 10px;
left: 20px;
margin: 0;
z-index: 1000;
width: 1050px;
text-align: center;
}

p.banner {
border-radius: 4px;
color: #004831;
background: #76b900;
}

footer div p {
font-size: 80%;
}

footer div p a {
color: var(--small-font-color);
}

footer div p a:hover {
color: var(--small-font-color);
}
14 changes: 14 additions & 0 deletions docs/source/_templates/footer.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{% extends '!footer.html' %}
{% block contentinfo %}
{{ super() }}
<p>
<a href="https://www.nvidia.com/en-us/about-nvidia/privacy-policy/" target="_blank">Privacy Policy</a> |
<a href="https://www.nvidia.com/en-us/about-nvidia/privacy-center/" target="_blank">Manage My Privacy</a> |
<a href="https://www.nvidia.com/en-us/preferences/start/" target="_blank">Do Not Sell or Share My Data</a> |
<a href="https://www.nvidia.com/en-us/about-nvidia/terms-of-service/" target="_blank">Terms of Service</a> |
<a href="https://www.nvidia.com/en-us/about-nvidia/accessibility/" target="_blank">Accessibility</a> |
<a href="https://www.nvidia.com/en-us/about-nvidia/company-policies/" target="_blank">Corporate Policies</a> |
<a href="https://www.nvidia.com/en-us/product-security/" target="_blank">Product Security</a> |
<a href="https://www.nvidia.com/en-us/contact/" target="_blank">Contact</a>
</p>
{% endblock %}
10 changes: 9 additions & 1 deletion docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import subprocess
import sys

from datetime import datetime
from natsort import natsorted

# -- Path setup --------------------------------------------------------------
Expand All @@ -25,8 +26,13 @@

# -- Project information -----------------------------------------------------

year_range = "2022"
year_now = str(datetime.now().year)
if year_range != year_now:
year_range = year_range + chr(8211) + year_now

project = "Merlin Dataloader"
copyright = "2022, NVIDIA" # pylint: disable=W0622
copyright = year_range + ", NVIDIA" # pylint: disable=W0622
author = "NVIDIA"


Expand Down Expand Up @@ -81,6 +87,7 @@
html_theme = "sphinx_rtd_theme"
html_copy_source = False
html_show_sourcelink = False
html_show_sphinx = False
html_theme_options = {
"navigation_depth": 3,
"analytics_id": "G-NVJ1Y1YJHK",
Expand All @@ -90,6 +97,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"]

# Configuration file for the Sphinx documentation builder.

Expand Down
13 changes: 0 additions & 13 deletions requirements/dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,19 +11,6 @@ testbook
moto>=2
cpplint>=1.5

# docs
Sphinx<3.6
jinja2<3.1
markupsafe==2.0.1
sphinx_markdown_tables==0.0.15
sphinx-multiversion@git+https://github.com/mikemckiernan/sphinx-multiversion.git
sphinxcontrib-copydirs@git+https://github.com/mikemckiernan/sphinxcontrib-copydirs.git
sphinx-external-toc<0.4
sphinx_rtd_theme
natsort<8.2
myst-nb<0.14
linkify-it-py<1.1

# needed to avoid bug in sphinx-markdown-tables
# https://github.com/ryanfox/sphinx-markdown-tables/issues/36
markdown==3.3.7
7 changes: 1 addition & 6 deletions requirements/docs.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,3 @@
-r base.txt
-r dev.txt

tritonclient[all]
tensorflow<=2.9.0

Sphinx==3.5.4
sphinx_rtd_theme==1.0.0
sphinx-multiversion@git+https://github.com/mikemckiernan/sphinx-multiversion.git
Expand All @@ -12,6 +6,7 @@ recommonmark==0.7.1
Jinja2<3.1
natsort==8.0.1
myst-nb==0.13.2
lxml<5.1
linkify-it-py==1.0.3
sphinx-external-toc==0.2.4
attrs==21.4.0
1 change: 1 addition & 0 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@ def read_requirements(filename):
"torch": read_requirements("requirements/torch.txt"),
"jax": read_requirements("requirements/jax.txt"),
"dev": read_requirements("requirements/dev.txt"),
"docs": read_requirements("requirements/docs.txt"),
}

with open("README.md", encoding="utf8") as readme:
Expand Down
Loading