This is an automated email from the ASF dual-hosted git repository.
yao pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/kyuubi.git
The following commit(s) were added to refs/heads/master by this push:
new 85caea86df [KYUUBI #6970] [DOC] Fix "nonexisting document" issues
85caea86df is described below
commit 85caea86dfb5fe05babfe76c314baf44bca198a8
Author: dnskr <[email protected]>
AuthorDate: Mon Mar 10 12:11:17 2025 +0800
[KYUUBI #6970] [DOC] Fix "nonexisting document" issues
### Why are the changes needed?
The PR fixes `nonexisting document` issues:
```shell
./kyuubi/docs/client/advanced/features/index.rst:19: WARNING: toctree
contains reference to nonexisting document
'client/advanced/features/engine_resources' [toc.not_readable]
./kyuubi/docs/client/odbc/index.rst:20: WARNING: toctree contains reference
to nonexisting document 'client/odbc/todo' [toc.not_readable]
./kyuubi/docs/client/thrift/index.rst:20: WARNING: toctree contains
reference to nonexisting document 'client/thrift/hive_beeline'
[toc.not_readable]
./kyuubi/docs/index.rst:189: WARNING: toctree contains reference to
nonexisting document 'sql/index' [toc.not_readable]
./kyuubi/docs/quick_start/index.rst:23: WARNING: toctree contains reference
to nonexisting document 'quick_start/quick_start_with_beeline'
[toc.not_readable]
```
### How was this patch tested?
Checked that there are no `nonexisting document` warnings during the
documentation build process.
```shell
make html
```
### Was this patch authored or co-authored using generative AI tooling?
No
Closes #6970 from dnskr/doc-fix-nonexisting-document.
Closes #6970
a7c2b3617 [dnskr] [DOC] Fix "nonexisting document" issues
Authored-by: dnskr <[email protected]>
Signed-off-by: Kent Yao <[email protected]>
---
.../{engine_resouces.rst => engine_resources.rst} | 0
docs/client/index.rst | 4 +---
docs/client/odbc/index.rst | 24 ----------------------
docs/client/thrift/index.rst | 24 ----------------------
docs/index.rst | 1 -
docs/quick_start/index.rst | 2 --
6 files changed, 1 insertion(+), 54 deletions(-)
diff --git a/docs/client/advanced/features/engine_resouces.rst
b/docs/client/advanced/features/engine_resources.rst
similarity index 100%
rename from docs/client/advanced/features/engine_resouces.rst
rename to docs/client/advanced/features/engine_resources.rst
diff --git a/docs/client/index.rst b/docs/client/index.rst
index 049f59348a..3004f530b9 100644
--- a/docs/client/index.rst
+++ b/docs/client/index.rst
@@ -31,9 +31,7 @@ In addition, APIs like REST, Thrift, etc., allow developers
to access kyuubi dir
jdbc/index
cli/index
bi_tools/index
- odbc/index
- thrift/index
rest/index
ui/index
python/index
- advanced/index
\ No newline at end of file
+ advanced/index
diff --git a/docs/client/odbc/index.rst b/docs/client/odbc/index.rst
deleted file mode 100644
index 0d4ed8b941..0000000000
--- a/docs/client/odbc/index.rst
+++ /dev/null
@@ -1,24 +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.
-
-
-ODBC Drivers
-============================
-
-.. toctree::
- :maxdepth: 2
-
- todo
-
diff --git a/docs/client/thrift/index.rst b/docs/client/thrift/index.rst
deleted file mode 100644
index e7def48240..0000000000
--- a/docs/client/thrift/index.rst
+++ /dev/null
@@ -1,24 +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.
-
-
-Thrift APIs
-===========
-
-.. toctree::
- :maxdepth: 2
-
- hive_beeline
-
diff --git a/docs/index.rst b/docs/index.rst
index 3c77d03f4f..8966ea444a 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -192,7 +192,6 @@ What's Next
:glob:
Clients & APIs <client/index>
- SQL References <sql/index>
.. toctree::
:caption: Extension Guide
diff --git a/docs/quick_start/index.rst b/docs/quick_start/index.rst
index d6096272ca..60bad27d4c 100644
--- a/docs/quick_start/index.rst
+++ b/docs/quick_start/index.rst
@@ -25,6 +25,4 @@ Quick Start
quick_start
quick_start_with_helm
- quick_start_with_beeline
quick_start_with_jdbc
-
