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/04/01 02:19:01 UTC
[flink-statefun] 04/09: [FLINK-16896][docs] Various cleanups in
docs, removing unused parts.
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 d280abb4549001da1cbf5ad3b469ff14da3e7cdd
Author: Stephan Ewen <se...@apache.org>
AuthorDate: Tue Mar 31 16:32:03 2020 +0200
[FLINK-16896][docs] Various cleanups in docs, removing unused parts.
The removed parts are leftover artifacts of adopting the docs system from the main Flink repo..
- Remove unused MathJax / LaTex related parts
- Remove docs README section on generated config tables
- Remove unused CSS sections
---
docs/README.md | 15 ---------------
docs/_includes/latex_commands.html | 38 --------------------------------------
docs/_layouts/base.html | 17 -----------------
docs/page/css/codetabs.css | 36 ------------------------------------
4 files changed, 106 deletions(-)
diff --git a/docs/README.md b/docs/README.md
index 78c8a47..3c47c7c 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -56,21 +56,6 @@ those changes reflected on every page.
| -e | Build only English docs |
| -z | Build only Chinese docs |
-## Generate configuration tables
-
-Configuration descriptions are auto generated from code. To trigger the generation you need to run:
-
-```
-mvn -Pgenerate-config-docs install
-```
-
-The resulting html files will be written to `_includes/generated`. Tables are regenerated each time the command is invoked.
-These tables can be directly included into the documentation:
-
-```
-{% include generated/file_name.html %}
-```
-
# Contribute
## Markdown
diff --git a/docs/_includes/latex_commands.html b/docs/_includes/latex_commands.html
deleted file mode 100644
index b2f8f08..0000000
--- a/docs/_includes/latex_commands.html
+++ /dev/null
@@ -1,38 +0,0 @@
-<!--
-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. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-
-<!--Some of the Latex math notation has been adapted from Apache Spark MLlib's documentation-->
-$$
-\newcommand{\R}{\mathbb{R}}
-\newcommand{\E}{\mathbb{E}}
-\newcommand{\x}{\mathbf{x}}
-\newcommand{\y}{\mathbf{y}}
-\newcommand{\wv}{\mathbf{w}}
-\newcommand{\av}{\mathbf{\alpha}}
-\newcommand{\bv}{\mathbf{b}}
-\newcommand{\N}{\mathbb{N}}
-\newcommand{\id}{\mathbf{I}}
-\newcommand{\ind}{\mathbf{1}}
-\newcommand{\0}{\mathbf{0}}
-\newcommand{\unit}{\mathbf{e}}
-\newcommand{\one}{\mathbf{1}}
-\newcommand{\zero}{\mathbf{0}}
-\newcommand\rfrac[2]{^{#1}\!/_{#2}}
-\newcommand{\norm}[1]{\left\lVert#1\right\rVert}
-$$
\ No newline at end of file
diff --git a/docs/_layouts/base.html b/docs/_layouts/base.html
index 9ba8cf8..e85db9a 100644
--- a/docs/_layouts/base.html
+++ b/docs/_layouts/base.html
@@ -34,19 +34,6 @@ under the License.
<link rel="stylesheet" href="{{ site.baseurl }}/page/css/syntax.css">
<link rel="stylesheet" href="{{ site.baseurl }}/page/css/codetabs.css">
<link rel="stylesheet" href="{{ site.baseurl }}/page/font-awesome/css/font-awesome.min.css">
- {% if page.mathjax %}
- <script type="text/x-mathjax-config">
- MathJax.Hub.Config({
- tex2jax: {
- inlineMath: [['$','$'], ['\\(','\\)']] },
- TeX: {
- equationNumbers: { autoNumber: "AMS" } }
- });
- </script>
- <script type="text/javascript"
- src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
- </script>
- {% endif %}
<!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
<!-- WARNING: Respond.js doesn't work if you view the page via file:// -->
<!--[if lt IE 9]>
@@ -76,10 +63,6 @@ under the License.
{% include sidenav.html %}
</div>
<div class="col-lg-9 content" id="contentcol">
- {%- if page.mathjax -%}
- {%- include latex_commands.html -%}
- {%- endif %}
-
{{ content }}
</div>
</div>
diff --git a/docs/page/css/codetabs.css b/docs/page/css/codetabs.css
index f62c67a..949453e 100644
--- a/docs/page/css/codetabs.css
+++ b/docs/page/css/codetabs.css
@@ -17,42 +17,6 @@
* under the License.
**/
-/**
- * Make dropdown menus in nav bars show on hover instead of click
- * using solution at http://stackoverflow.com/questions/8878033/how-
- * to-make-twitter-bootstrap-menu-dropdown-on-hover-rather-than-click
- **/
-ul.nav li.dropdown:hover ul.dropdown-menu{
- display: block;
-}
-
-a.menu:after, .dropdown-toggle:after {
- content: none;
-}
-
-/** Make the submenus open on hover on the parent menu item */
-ul.nav li.dropdown ul.dropdown-menu li.dropdown-submenu:hover ul.dropdown-menu {
- display: block;
-}
-
-/** Make the submenus be invisible until the parent menu item is hovered upon */
-ul.nav li.dropdown ul.dropdown-menu li.dropdown-submenu ul.dropdown-menu {
- display: none;
-}
-
-/**
- * Made the navigation bar buttons not grey out when clicked.
- * Essentially making nav bar buttons not react to clicks, only hover events.
- */
-.navbar .nav li.dropdown.open > .dropdown-toggle {
- background-color: transparent;
-}
-
-/**
- * Made the active tab caption blue. Otherwise the active tab is black, and inactive tab is blue.
- * That looks weird. Changed the colors to active - blue, inactive - black, and
- * no color change on hover.
- */
.nav-tabs > li.active > a, .nav-tabs > li.active > a:hover {
color: #08c !important;
}