Skip to content

Commit a691900

Browse files
committed
docs: nest toctrees in section index pages for sidebar nav
1 parent 9cb7dc3 commit a691900

3 files changed

Lines changed: 22 additions & 37 deletions

File tree

‎docs/source/contributor-guide/index.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ Branch from `main`, write changes with
3838
the imperative mood (e.g. `feat: add foo`, `fix(native): handle bar`),
3939
and open a pull request targeting `main`.
4040

41-
## Topics
42-
43-
- [Development](development.md) — build prerequisites, running tests,
44-
TPC-H test data, repo layout.
45-
- [Code style](code-style.md) — formatters and license headers.
46-
- [Releasing](releasing.md) — Apache release process (placeholder).
47-
- [Updating DataFusion / protobuf version](updating-datafusion-version.md) —
48-
step-by-step recipe.
41+
```{toctree}
42+
:maxdepth: 1
43+
44+
development
45+
code-style
46+
releasing
47+
updating-datafusion-version
48+
```

‎docs/source/index.md‎

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -69,27 +69,10 @@ Code of Conduct <https://github.com/apache/datafusion/blob/main/CODE_OF_CONDUCT.
6969
```
7070

7171
```{toctree}
72-
:maxdepth: 1
73-
:caption: User Guide
74-
:hidden:
75-
76-
user-guide/index
77-
user-guide/installation
78-
user-guide/quickstart
79-
user-guide/sessioncontext
80-
user-guide/dataframe
81-
user-guide/parquet
82-
user-guide/project-status
83-
```
84-
85-
```{toctree}
86-
:maxdepth: 1
87-
:caption: Contributor Guide
72+
:maxdepth: 2
73+
:caption: Documentation
8874
:hidden:
8975
90-
contributor-guide/index
91-
contributor-guide/development
92-
contributor-guide/code-style
93-
contributor-guide/releasing
94-
contributor-guide/updating-datafusion-version
76+
User Guide <user-guide/index>
77+
Contributor Guide <contributor-guide/index>
9578
```

‎docs/source/user-guide/index.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,14 +28,16 @@ Data Interface.
2828
This guide covers installation, the `SessionContext` and `DataFrame` APIs,
2929
and Parquet ingestion.
3030

31-
- [Installation](installation.md) — JDK and Rust prerequisites, building
32-
from source.
33-
- [Quickstart](quickstart.md) — a complete example, walked through.
34-
- [SessionContext](sessioncontext.md) — lifecycle and threading.
35-
- [DataFrame and SQL](dataframe.md) — building and executing queries.
36-
- [Parquet](parquet.md) — registering files and reading them with
37-
`ParquetReadOptions`.
38-
- [Project status](project-status.md) — snapshot of what works today.
31+
```{toctree}
32+
:maxdepth: 1
33+
34+
installation
35+
quickstart
36+
sessioncontext
37+
dataframe
38+
parquet
39+
project-status
40+
```
3941

4042
> Early development: no releases yet, API will change. Bug reports and
4143
> contributions welcome.

0 commit comments

Comments
 (0)