Skip to content

Have the --colored default value be yes in the docs #2289

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Dec 20, 2021
Merged

Have the --colored default value be yes in the docs #2289

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b7a39d3
Have the --colored default value be yes in the docs
Dec 20, 2021
4dc3ecd
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Dec 20, 2021
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 docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
from __future__ import annotations

import os
import sys
from datetime import date, datetime
from pathlib import Path
Expand Down Expand Up @@ -86,6 +87,8 @@
nitpicky = True
nitpick_ignore = []

os.environ["FORCE_COLOR"] = "yes" # force --colored default value to be yes


def skip_member(app: Sphinx, what: str, name: str, obj: Any, would_skip: bool, options: Options) -> bool: # noqa: U100
return name in options.get("exclude-members", set()) or would_skip
Expand Down