Skip to content

Commit ac50d7d

Browse files
committed
docs: Remove manual tables of content (#2921)
1 parent 6f56077 commit ac50d7d

File tree

6 files changed

+7
-57
lines changed

6 files changed

+7
-57
lines changed

axum/CHANGELOG.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8+
# Unreleased
9+
10+
- **change**: Remove manual tables of content from the documentation, since
11+
rustdoc now generates tables of content in the sidebar ([#2921])
12+
13+
[#2921]: https://github.com/tokio-rs/axum/pull/2921
14+
815
# 0.7.6
916

1017
- **change:** Avoid cloning `Arc` during deserialization of `Path`

axum/src/docs/error_handling.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,5 @@
11
Error handling model and utilities
22

3-
# Table of contents
4-
5-
- [axum's error handling model](#axums-error-handling-model)
6-
- [Routing to fallible services](#routing-to-fallible-services)
7-
- [Applying fallible middleware](#applying-fallible-middleware)
8-
- [Running extractors for error handling](#running-extractors-for-error-handling)
9-
103
# axum's error handling model
114

125
axum is based on [`tower::Service`] which bundles errors through its associated

axum/src/docs/extract.md

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,5 @@
11
Types and traits for extracting data from requests.
22

3-
# Table of contents
4-
5-
- [Intro](#intro)
6-
- [Common extractors](#common-extractors)
7-
- [Applying multiple extractors](#applying-multiple-extractors)
8-
- [The order of extractors](#the-order-of-extractors)
9-
- [Optional extractors](#optional-extractors)
10-
- [Customizing extractor responses](#customizing-extractor-responses)
11-
- [Accessing inner errors](#accessing-inner-errors)
12-
- [Defining custom extractors](#defining-custom-extractors)
13-
- [Accessing other extractors in `FromRequest` or `FromRequestParts` implementations](#accessing-other-extractors-in-fromrequest-or-fromrequestparts-implementations)
14-
- [Request body limits](#request-body-limits)
15-
- [Wrapping extractors](#wrapping-extractors)
16-
- [Logging rejections](#logging-rejections)
17-
183
# Intro
194

205
A handler function is an async function that takes any number of

axum/src/docs/middleware.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,3 @@
1-
# Table of contents
2-
3-
- [Intro](#intro)
4-
- [Applying middleware](#applying-middleware)
5-
- [Commonly used middleware](#commonly-used-middleware)
6-
- [Ordering](#ordering)
7-
- [Writing middleware](#writing-middleware)
8-
- [Routing to services/middleware and backpressure](#routing-to-servicesmiddleware-and-backpressure)
9-
- [Accessing state in middleware](#accessing-state-in-middleware)
10-
- [Passing state from middleware to handlers](#passing-state-from-middleware-to-handlers)
11-
- [Rewriting request URI in middleware](#rewriting-request-uri-in-middleware)
12-
131
# Intro
142

153
axum is unique in that it doesn't have its own bespoke middleware system and

axum/src/docs/response.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,5 @@
11
Types and traits for generating responses.
22

3-
# Table of contents
4-
5-
- [Building responses](#building-responses)
6-
- [Returning different response types](#returning-different-response-types)
7-
- [Regarding `impl IntoResponse`](#regarding-impl-intoresponse)
8-
93
# Building responses
104

115
Anything that implements [`IntoResponse`] can be returned from a handler. axum

axum/src/lib.rs

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,5 @@
11
//! axum is a web application framework that focuses on ergonomics and modularity.
22
//!
3-
//! # Table of contents
4-
//!
5-
//! - [High-level features](#high-level-features)
6-
//! - [Compatibility](#compatibility)
7-
//! - [Example](#example)
8-
//! - [Routing](#routing)
9-
//! - [Handlers](#handlers)
10-
//! - [Extractors](#extractors)
11-
//! - [Responses](#responses)
12-
//! - [Error handling](#error-handling)
13-
//! - [Middleware](#middleware)
14-
//! - [Sharing state with handlers](#sharing-state-with-handlers)
15-
//! - [Building integrations for axum](#building-integrations-for-axum)
16-
//! - [Required dependencies](#required-dependencies)
17-
//! - [Examples](#examples)
18-
//! - [Feature flags](#feature-flags)
19-
//!
203
//! # High-level features
214
//!
225
//! - Route requests to handlers with a macro-free API.

0 commit comments

Comments
 (0)