-
Notifications
You must be signed in to change notification settings - Fork 155
Improve documentation site layout #1578
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
timsaucer
wants to merge
11
commits into
apache:main
Choose a base branch
from
timsaucer:doc/phase1-theme-refresh
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+240
−112
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
b79fe4b
docs: refresh theme — pydata-sphinx-theme 0.16, top navbar, dark mode
timsaucer a4a7e61
docs: collapse navbar to section landing pages
timsaucer f4971a4
docs: restore external links lost in navbar restructure
timsaucer 41030ef
docs: render Rust API link as docs.rs icon next to GitHub
timsaucer 3c8b530
docs: render sidebar nav on landing page
timsaucer 52c0095
docs: render expandable chevrons in sidebar nav
timsaucer f2ff306
docs: expand sidebar to show level 2 entries by default
timsaucer 6c26487
docs: add Links sidebar section for external references
timsaucer fd74a26
docs: consolidate external URLs into a single Links nav item
timsaucer 9e933fc
docs: add favicon matching the main datafusion site
timsaucer 99e10de
docs: address Copilot review feedback on sidebar config
timsaucer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| {# Renders the global document toctree on every page (including the | ||
| landing page) with pydata-sphinx-theme's collapsible chevrons. | ||
|
|
||
| The stock sidebar-nav-bs.html starts at the current section and is | ||
| stripped from the sidebar list by suppress_sidebar_toctree() on the | ||
| root page (no parent section). Using generate_toctree_html with | ||
| startdepth=0 renders the whole tree from root with the bootstrap | ||
| classes the theme's JS uses for expand/collapse toggles. Naming the | ||
| template "sidebar-globaltoc" sidesteps the suppress filter, which | ||
| matches on "sidebar-nav-bs.html" specifically. #} | ||
| <nav class="bd-docs-nav bd-links" aria-label="{{ _('Section Navigation') }}"> | ||
| <p class="bd-links__title" role="heading" aria-level="1">{{ _("Section Navigation") }}</p> | ||
| <div class="bd-toc-item navbar-nav"> | ||
| {# collapse=False so nested <ul>s render into the DOM for every | ||
| branch; the theme's JS then adds the expand/collapse chevrons | ||
| on top. show_nav_level is driven by theme_show_nav_level (set | ||
| in conf.py) so callers can adjust how deep the sidebar opens | ||
| by default without editing this template. #} | ||
| {{- generate_toctree_html( | ||
| "sidebar", | ||
| startdepth=0, | ||
| show_nav_level=theme_show_nav_level | int, | ||
| maxdepth=theme_navigation_depth | int, | ||
| collapse=False, | ||
| includehidden=True, | ||
| titles_only=True | ||
| ) | ||
| -}} | ||
| </div> | ||
| </nav> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| .. 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. | ||
|
|
||
| ================= | ||
| Contributor Guide | ||
| ================= | ||
|
|
||
| Guides for contributors to the DataFusion in Python project. | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
||
| introduction | ||
| ffi |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| .. 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. | ||
|
|
||
| ===== | ||
| Links | ||
| ===== | ||
|
|
||
| External resources for the DataFusion in Python project. | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 1 | ||
|
|
||
| GitHub and Issue Tracker <https://github.com/apache/datafusion-python> | ||
| Rust API Docs <https://docs.rs/datafusion/latest/datafusion/> | ||
| Code of Conduct <https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.md> | ||
| Examples <https://github.com/apache/datafusion-python/tree/main/examples> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| .. 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. | ||
|
|
||
| ========== | ||
| User Guide | ||
| ========== | ||
|
|
||
| The user guide walks through installing DataFusion in Python, building queries | ||
| with the DataFrame API or SQL, reading and writing data, and tuning execution. | ||
|
|
||
| .. toctree:: | ||
| :maxdepth: 2 | ||
|
|
||
| introduction | ||
| basics | ||
| data-sources | ||
| dataframe/index | ||
| common-operations/index | ||
| io/index | ||
| configuration | ||
| distributing-work | ||
| sql | ||
| upgrade-guides | ||
| ai-coding-assistants |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.