Skip to content

Commit fd74a26

Browse files
timsaucerclaude
andcommitted
docs: consolidate external URLs into a single Links nav item
Replace the second hidden toctree (which expanded each external URL into its own navbar entry) with a dedicated links.rst landing page, and add a single "links" entry to the main toctree. Top navbar now shows User Guide / Contributor Guide / API Reference / Links — four items, no wrapping. Clicking Links opens the page that lists GitHub, Rust API Docs, Code of Conduct, and Examples. Drop the external_links Examples entry from conf.py since the same URL now lives on the Links page. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 6c26487 commit fd74a26

3 files changed

Lines changed: 31 additions & 16 deletions

File tree

docs/source/conf.py

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -138,12 +138,6 @@ def setup(sphinx) -> None:
138138
"icon": "fa-brands fa-rust",
139139
},
140140
],
141-
"external_links": [
142-
{
143-
"name": "Examples",
144-
"url": "https://github.com/apache/datafusion-python/tree/main/examples",
145-
},
146-
],
147141
"secondary_sidebar_items": [],
148142
"collapse_navigation": True,
149143
"show_nav_level": 2,

docs/source/index.rst

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,13 +59,4 @@ Example
5959
user-guide/index
6060
contributor-guide/index
6161
API Reference <autoapi/index>
62-
63-
.. toctree::
64-
:hidden:
65-
:maxdepth: 1
66-
:caption: Links
67-
68-
GitHub and Issue Tracker <https://github.com/apache/datafusion-python>
69-
Rust API Docs <https://docs.rs/datafusion/latest/datafusion/>
70-
Code of Conduct <https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md>
71-
Examples <https://github.com/apache/datafusion-python/tree/main/examples>
62+
links

docs/source/links.rst

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
.. Licensed to the Apache Software Foundation (ASF) under one
2+
.. or more contributor license agreements. See the NOTICE file
3+
.. distributed with this work for additional information
4+
.. regarding copyright ownership. The ASF licenses this file
5+
.. to you under the Apache License, Version 2.0 (the
6+
.. "License"); you may not use this file except in compliance
7+
.. with the License. You may obtain a copy of the License at
8+
9+
.. http://www.apache.org/licenses/LICENSE-2.0
10+
11+
.. Unless required by applicable law or agreed to in writing,
12+
.. software distributed under the License is distributed on an
13+
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
.. KIND, either express or implied. See the License for the
15+
.. specific language governing permissions and limitations
16+
.. under the License.
17+
18+
=====
19+
Links
20+
=====
21+
22+
External resources for the DataFusion in Python project.
23+
24+
.. toctree::
25+
:maxdepth: 1
26+
27+
GitHub and Issue Tracker <https://github.com/apache/datafusion-python>
28+
Rust API Docs <https://docs.rs/datafusion/latest/datafusion/>
29+
Code of Conduct <https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md>
30+
Examples <https://github.com/apache/datafusion-python/tree/main/examples>

0 commit comments

Comments
 (0)