Skip to content
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

docs: Remove manual tables of content #2921

Merged
merged 1 commit into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions axum/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
# Unreleased

- **breaking:** The tuple and tuple_struct `Path` extractor deserializers now check that the number of parameters matches the tuple length exactly ([#2931])
- **change**: Remove manual tables of content from the documentation, since
rustdoc now generates tables of content in the sidebar ([#2921])
Comment on lines +11 to +12
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want this in the changelog? If users upgrading to a new version is the intended audience, I'm not sure this is something they need to know.

Otherwise I don't know who the intended audience is or if we want all, even infrastructure changes, to be in the changelog.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah it's not really necessary but I'd like to make a patch release with this and I think empty / no changelogs are not nice.


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

# 0.7.6
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