677e2a40ab
### _Why are the changes needed?_ https://kyuubi.apache.org/docs/latest/deployment/settings.html The configuration parameters in the document are too long and a newline is inserted(`<br/>`), which makes it difficult to search. And if the user copies the configuration parameters, it may become several lines. Use `<code>` to replace `<br/>`. https://github.com/apache/incubator-kyuubi/issues/1889 ### _How was this patch tested?_ - [x] Add some test cases that check the changes thoroughly including negative and positive cases if possible - [x] Add screenshots for manual tests if appropriate - [ ] [Run test](https://kyuubi.apache.org/docs/latest/develop_tools/testing.html#running-tests) locally before make a pull request Closes #1890 from cxzl25/KYUUBI-1889. Closes #1889 765b0622 [sychen] format metrics.md abeb0601 [sychen] add newline 28865ad7 [sychen] increase max width 2f9c7e05 [sychen] use <code> Authored-by: sychen <sychen@trip.com> Signed-off-by: ulysses-you <ulyssesyou@apache.org>
133 lines
4.6 KiB
Python
133 lines
4.6 KiB
Python
#!/usr/bin/env python3
|
|
#
|
|
# 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.
|
|
#
|
|
|
|
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
|
|
import os
|
|
import sys
|
|
import shlex
|
|
import subprocess
|
|
|
|
sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
import sphinx_rtd_theme
|
|
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
|
|
|
|
import sphinx_markdown_tables
|
|
import recommonmark
|
|
from recommonmark.transform import AutoStructify
|
|
from recommonmark.parser import CommonMarkParser
|
|
# source_parsers = {
|
|
# '.md': CommonMarkParser,
|
|
# }
|
|
|
|
source_suffix = ['.rst', '.md']
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = 'Kyuubi'
|
|
|
|
copyright = '''
|
|
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.
|
|
'''
|
|
|
|
author = 'Kent Yao'
|
|
|
|
# The full version, including alpha/beta/rc tags
|
|
release = subprocess.getoutput("cd .. && build/mvn help:evaluate -Dexpression=project.version|grep -v Using|grep -v INFO|grep -v WARNING|tail -n 1").split('\n')[-1]
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# 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.autodoc',
|
|
'sphinx.ext.napoleon',
|
|
'sphinx.ext.mathjax',
|
|
'recommonmark',
|
|
'sphinx_markdown_tables',
|
|
'notfound.extension',
|
|
]
|
|
|
|
master_doc = 'index'
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ['_templates']
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = 'sphinx_rtd_theme'
|
|
# html_theme_options = {
|
|
# 'logo_only': True
|
|
# }
|
|
|
|
html_logo = 'imgs/kyuubi_logo_gray.png'
|
|
|
|
|
|
pygments_style = 'sphinx'
|
|
|
|
# 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 = ['_static']
|
|
html_style = 'css/custom.css'
|
|
htmlhelp_basename = 'Recommonmarkdoc'
|
|
|
|
github_doc_root = 'https://github.com/apache/incubator-kyuubi/tree/master/docs/'
|
|
def setup(app):
|
|
app.add_config_value('recommonmark_config', {
|
|
'url_resolver': lambda url: github_doc_root + url,
|
|
'auto_toc_tree_section': 'Contents',
|
|
'enable_eval_rst': True,
|
|
}, True)
|
|
app.add_transform(AutoStructify)
|