Skip to content

Added tabs for configuration files in the documentation#8480

Merged
charliermarsh merged 8 commits intoastral-sh:mainfrom
trag1c:config-tabs
Nov 5, 2023
Merged

Added tabs for configuration files in the documentation#8480
charliermarsh merged 8 commits intoastral-sh:mainfrom
trag1c:config-tabs

Conversation

@trag1c
Copy link
Contributor

@trag1c trag1c commented Nov 3, 2023

Summary

Closes #8384.

Test Plan

Checked whether it renders properly on the mkdocs serve preview.

@trag1c
Copy link
Contributor Author

trag1c commented Nov 3, 2023

It seems like the syntax required by the tabs plugin goes against mdformat's requirements. Should the hook be removed from pre-commit?

Edit: I excluded the docs folder from mdformat and markdownlint hooks

@github-actions
Copy link
Contributor

github-actions bot commented Nov 3, 2023

ruff-ecosystem results

Formatter (stable)

✅ ecosystem check detected no format changes.

Formatter (preview)

✅ ecosystem check detected no format changes.

//! Used for <https://docs.astral.sh/ruff/settings/>.
use std::fmt::Write;

use ruff_python_trivia::textwrap;
Copy link
Member

Choose a reason for hiding this comment

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

Ohh I didn't realize when you asked this that it was specifically for Ruff 😂

Copy link
Contributor Author

Choose a reason for hiding this comment

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

:D

Copy link
Member

@charliermarsh charliermarsh left a comment

Choose a reason for hiding this comment

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

This is excellent, thank you so much!

@charliermarsh charliermarsh added the documentation Improvements or additions to documentation label Nov 5, 2023
@charliermarsh
Copy link
Member

(Fixing Clippy, which I broke.)

@charliermarsh charliermarsh enabled auto-merge (squash) November 5, 2023 17:06
@charliermarsh charliermarsh merged commit 1672a3d into astral-sh:main Nov 5, 2023
@doolio
Copy link
Contributor

doolio commented Nov 5, 2023

Great job @trag1c. This makes it so much better for me as a beginner.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Show configuration toml files in tabs within the docs

3 participants