aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorBu Sun Kim <8822365+busunkim96@users.noreply.github.com>2019-11-11 15:15:32 -0800
committerGitHub <noreply@github.com>2019-11-11 15:15:32 -0800
commit0f6ad2a13ad633622c1a3881c597ac1e5c51faf5 (patch)
tree25ca803fe305f4e98b7f3c9f3d7afebd64d64740 /docs
parent9230dd4b8ad9b457d53a6dd5fd353c780cc06ed5 (diff)
downloadpython-api-core-0f6ad2a13ad633622c1a3881c597ac1e5c51faf5.tar.gz
docs: add python 2 sunset banner to documentation (#9036)
Diffstat (limited to 'docs')
-rw-r--r--docs/_static/custom.css4
-rw-r--r--docs/_templates/layout.html49
-rw-r--r--docs/conf.py2
3 files changed, 54 insertions, 1 deletions
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
new file mode 100644
index 0000000..9a6f9f8
--- /dev/null
+++ b/docs/_static/custom.css
@@ -0,0 +1,4 @@
+div#python2-eol {
+ border-color: red;
+ border-width: medium;
+} \ No newline at end of file
diff --git a/docs/_templates/layout.html b/docs/_templates/layout.html
new file mode 100644
index 0000000..de457b2
--- /dev/null
+++ b/docs/_templates/layout.html
@@ -0,0 +1,49 @@
+{% extends "!layout.html" %}
+{%- block content %}
+{%- if theme_fixed_sidebar|lower == 'true' %}
+ <div class="document">
+ {{ sidebar() }}
+ {%- block document %}
+ <div class="documentwrapper">
+ {%- if render_sidebar %}
+ <div class="bodywrapper">
+ {%- endif %}
+
+ {%- block relbar_top %}
+ {%- if theme_show_relbar_top|tobool %}
+ <div class="related top">
+ &nbsp;
+ {{- rellink_markup () }}
+ </div>
+ {%- endif %}
+ {% endblock %}
+
+ <div class="body" role="main">
+ <div class="admonition" id="python2-eol">
+ On January 1, 2020 this library will no longer support Python 2 on the latest released version.
+ Previously released library versions will continue to be available. For more information please
+ visit <a href="https://cloud.google.com/python/docs/python2-sunset/">Python 2 support on Google Cloud</a>.
+ </div>
+ {% block body %} {% endblock %}
+ </div>
+
+ {%- block relbar_bottom %}
+ {%- if theme_show_relbar_bottom|tobool %}
+ <div class="related bottom">
+ &nbsp;
+ {{- rellink_markup () }}
+ </div>
+ {%- endif %}
+ {% endblock %}
+
+ {%- if render_sidebar %}
+ </div>
+ {%- endif %}
+ </div>
+ {%- endblock %}
+ <div class="clearer"></div>
+ </div>
+{%- else %}
+{{ super() }}
+{%- endif %}
+{%- endblock %}
diff --git a/docs/conf.py b/docs/conf.py
index b92886d..ef04929 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -164,7 +164,7 @@ html_theme_options = {
# Add any paths that contain custom static files (such as style sheets) here,
# 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 = []
+html_static_path = ["_static"]
# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied