Skip to content

Commit

Permalink
docs: Remove manual tables of content (#2921)
Browse files Browse the repository at this point in the history
  • Loading branch information
jplatte committed Sep 27, 2024
1 parent 6f56077 commit ac50d7d
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 57 deletions.
7 changes: 7 additions & 0 deletions axum/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

# Unreleased

- **change**: Remove manual tables of content from the documentation, since
rustdoc now generates tables of content in the sidebar ([#2921])

[#2921]: https://github.com/tokio-rs/axum/pull/2921

# 0.7.6

- **change:** Avoid cloning `Arc` during deserialization of `Path`
Expand Down
7 changes: 0 additions & 7 deletions axum/src/docs/error_handling.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,5 @@
Error handling model and utilities

# Table of contents

- [axum's error handling model](#axums-error-handling-model)
- [Routing to fallible services](#routing-to-fallible-services)
- [Applying fallible middleware](#applying-fallible-middleware)
- [Running extractors for error handling](#running-extractors-for-error-handling)

# axum's error handling model

axum is based on [`tower::Service`] which bundles errors through its associated
Expand Down
15 changes: 0 additions & 15 deletions axum/src/docs/extract.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,5 @@
Types and traits for extracting data from requests.

# Table of contents

- [Intro](#intro)
- [Common extractors](#common-extractors)
- [Applying multiple extractors](#applying-multiple-extractors)
- [The order of extractors](#the-order-of-extractors)
- [Optional extractors](#optional-extractors)
- [Customizing extractor responses](#customizing-extractor-responses)
- [Accessing inner errors](#accessing-inner-errors)
- [Defining custom extractors](#defining-custom-extractors)
- [Accessing other extractors in `FromRequest` or `FromRequestParts` implementations](#accessing-other-extractors-in-fromrequest-or-fromrequestparts-implementations)
- [Request body limits](#request-body-limits)
- [Wrapping extractors](#wrapping-extractors)
- [Logging rejections](#logging-rejections)

# Intro

A handler function is an async function that takes any number of
Expand Down
12 changes: 0 additions & 12 deletions axum/src/docs/middleware.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,3 @@
# Table of contents

- [Intro](#intro)
- [Applying middleware](#applying-middleware)
- [Commonly used middleware](#commonly-used-middleware)
- [Ordering](#ordering)
- [Writing middleware](#writing-middleware)
- [Routing to services/middleware and backpressure](#routing-to-servicesmiddleware-and-backpressure)
- [Accessing state in middleware](#accessing-state-in-middleware)
- [Passing state from middleware to handlers](#passing-state-from-middleware-to-handlers)
- [Rewriting request URI in middleware](#rewriting-request-uri-in-middleware)

# Intro

axum is unique in that it doesn't have its own bespoke middleware system and
Expand Down
6 changes: 0 additions & 6 deletions axum/src/docs/response.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,5 @@
Types and traits for generating responses.

# Table of contents

- [Building responses](#building-responses)
- [Returning different response types](#returning-different-response-types)
- [Regarding `impl IntoResponse`](#regarding-impl-intoresponse)

# Building responses

Anything that implements [`IntoResponse`] can be returned from a handler. axum
Expand Down
17 changes: 0 additions & 17 deletions axum/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,22 +1,5 @@
//! axum is a web application framework that focuses on ergonomics and modularity.
//!
//! # Table of contents
//!
//! - [High-level features](#high-level-features)
//! - [Compatibility](#compatibility)
//! - [Example](#example)
//! - [Routing](#routing)
//! - [Handlers](#handlers)
//! - [Extractors](#extractors)
//! - [Responses](#responses)
//! - [Error handling](#error-handling)
//! - [Middleware](#middleware)
//! - [Sharing state with handlers](#sharing-state-with-handlers)
//! - [Building integrations for axum](#building-integrations-for-axum)
//! - [Required dependencies](#required-dependencies)
//! - [Examples](#examples)
//! - [Feature flags](#feature-flags)
//!
//! # High-level features
//!
//! - Route requests to handlers with a macro-free API.
Expand Down

0 comments on commit ac50d7d

Please sign in to comment.