You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by tz...@apache.org on 2020/03/22 07:52:36 UTC
[flink-statefun] 08/11: [hotfix][docs] Add tabs and fix broken links
This is an automated email from the ASF dual-hosted git repository.
tzulitai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/flink-statefun.git
commit dcfa75da6e70af00df7d1c0ffa36a6f7e41da738
Author: Seth Wiesman <sj...@gmail.com>
AuthorDate: Sat Mar 21 15:03:01 2020 -0500
[hotfix][docs] Add tabs and fix broken links
---
statefun-docs/docs/_static/css/customize-theme.css | 15 ++++++++++-
statefun-docs/docs/_templates/layout.html | 1 +
statefun-docs/docs/_templates/searchbox.html | 0
statefun-docs/docs/conf.py | 20 +++------------
statefun-docs/docs/index_grid.html | 5 ++--
statefun-docs/requirements.txt | 29 +++++++++++++++++++++-
statefun-docs/runtime.txt | 2 +-
7 files changed, 50 insertions(+), 22 deletions(-)
diff --git a/statefun-docs/docs/_static/css/customize-theme.css b/statefun-docs/docs/_static/css/customize-theme.css
index d5ca922..e295514 100644
--- a/statefun-docs/docs/_static/css/customize-theme.css
+++ b/statefun-docs/docs/_static/css/customize-theme.css
@@ -51,4 +51,17 @@
.scv-banner > a {
color: white ! important;
-}
\ No newline at end of file
+}
+
+.sphinx-tabs .sphinx-menu a.item {
+ color: #446D6F !important;
+}
+
+.sphinx-tabs .sphinx-menu a.active.item {
+ border-color: #446D6F !important;
+}
+
+.sphinx-tab {
+ border-color: #446D6F !important;
+}
+
diff --git a/statefun-docs/docs/_templates/layout.html b/statefun-docs/docs/_templates/layout.html
index 89acd5a..05c177b 100644
--- a/statefun-docs/docs/_templates/layout.html
+++ b/statefun-docs/docs/_templates/layout.html
@@ -3,6 +3,7 @@
{%- set favicon = 'favicon.png' %}
{%- set logo = 'logo.png' %}
{%- set theme_logo_only = True %}
+{%- set extra_css_files = ['_static/css/customize-theme.css'] %}
{% block sidebartitle %}
diff --git a/statefun-docs/docs/_templates/searchbox.html b/statefun-docs/docs/_templates/searchbox.html
deleted file mode 100644
index e69de29..0000000
diff --git a/statefun-docs/docs/conf.py b/statefun-docs/docs/conf.py
index d8555e9..7817989 100644
--- a/statefun-docs/docs/conf.py
+++ b/statefun-docs/docs/conf.py
@@ -1,3 +1,4 @@
+
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
# this work for additional information regarding copyright ownership.
@@ -32,7 +33,8 @@ import re
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
-extensions = ['sphinx.ext.ifconfig']
+# https://github.com/djungelorm/sphinx-tabs
+extensions = ['sphinx.ext.ifconfig', 'sphinx_tabs.tabs']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -106,8 +108,6 @@ todo_include_todos = False
#
html_theme = 'sphinx_rtd_theme'
-theme_prev_next_buttons_location = 'Top'
-
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
@@ -139,22 +139,11 @@ html_sidebars = {
]
}
-# Custom CSS.
-html_css_files = [
- 'css/customize-theme.css',
-]
-
-html_context = {
- 'css_files': ['_static/css/customize-theme.css']
-}
-
-
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
htmlhelp_basename = 'StatefulFunctionsdoc'
-
# -- Options for LaTeX output ---------------------------------------------
latex_elements = {
@@ -180,7 +169,7 @@ latex_elements = {
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'StatefulFunctions.tex', u'Stateful Functions Documentation',
- u'Ververica GmbH', 'manual'),
+ u'Apache Flink', 'manual'),
]
@@ -205,7 +194,6 @@ texinfo_documents = [
'Miscellaneous'),
]
-
# -- Settings for sphinxcontrib-versioning --------------------------------
scv_greatest_tag = True
scv_show_banner = True
diff --git a/statefun-docs/docs/index_grid.html b/statefun-docs/docs/index_grid.html
index 4f8b2bb..e190a3d 100644
--- a/statefun-docs/docs/index_grid.html
+++ b/statefun-docs/docs/index_grid.html
@@ -49,11 +49,10 @@ under the License.
<div class="container">
<div class="btn-toolbar">
- <button onclick="window.location.href = '/overview/index.html';">Learn More</button>
- <button onclick="window.location.href = '/api_concepts/index.html';">Read The Docs</button>
+ <button onclick="window.location.href = '/concepts/index.html';">Read The Docs</button>
<button onclick="window.location.href = '/getting_started/index.html';">Get Started!</button>
</div>
</div>
-</html>
\ No newline at end of file
+</html>
diff --git a/statefun-docs/requirements.txt b/statefun-docs/requirements.txt
index 97882e2..3f5e986 100644
--- a/statefun-docs/requirements.txt
+++ b/statefun-docs/requirements.txt
@@ -1,5 +1,32 @@
+alabaster==0.7.12
+argh==0.26.2
+Babel==2.6.0
+certifi==2019.3.9
+chardet==3.0.4
+Click==7.0
+colorclass==2.2.0
+docutils==0.14
+idna==2.8
+imagesize==1.1.0
+Jinja2==2.10.1
+livereload==2.6.0
+MarkupSafe==1.1.1
+packaging==19.0
+pathtools==0.1.2
+port-for==0.3.1
+Pygments==2.3.1
+pyparsing==2.4.0
+pytz==2019.1
+PyYAML==5.1
+requests==2.21.0
six==1.11.0
+snowballstemmer==1.2.1
Sphinx==1.7.9
sphinx-autobuild==0.7.1
-sphinx_rtd_theme==0.4.1
+sphinx-rtd-theme==0.4.1
+sphinx-tabs==1.1.13
sphinxcontrib-versioning==2.2.1
+sphinxcontrib-websupport==1.1.0
+tornado==6.0.2
+urllib3==1.24.1
+watchdog==0.9.0
diff --git a/statefun-docs/runtime.txt b/statefun-docs/runtime.txt
index 475ba51..d70c8f8 100644
--- a/statefun-docs/runtime.txt
+++ b/statefun-docs/runtime.txt
@@ -1 +1 @@
-3.7
+3.6