From 86f85e4ff373ba980ec0c496395cd61acb8b88e2 Mon Sep 17 00:00:00 2001 From: Sam Clements Date: Fri, 26 Jan 2024 13:41:32 +0000 Subject: [PATCH] Rename doc/ folder to docs/ --- README.md | 2 +- {doc => docs}/colors.py | 0 {doc => docs}/custom_level.py | 0 {doc => docs}/example.png | Bin {doc => docs}/example.py | 0 {doc => docs}/yaml_example.py | 0 {doc => docs}/yaml_example.yaml | 0 tox.ini | 6 +++--- 8 files changed, 4 insertions(+), 4 deletions(-) rename {doc => docs}/colors.py (100%) rename {doc => docs}/custom_level.py (100%) rename {doc => docs}/example.png (100%) rename {doc => docs}/example.py (100%) rename {doc => docs}/yaml_example.py (100%) rename {doc => docs}/yaml_example.yaml (100%) diff --git a/README.md b/README.md index aa13451..df4be79 100644 --- a/README.md +++ b/README.md @@ -105,7 +105,7 @@ support for these varies wildly across different terminals. ## Examples -![Example output](doc/example.png) +![Example output](docs/example.png) The following code creates a `ColoredFormatter` for use in a logging setup, using the default values for each argument. diff --git a/doc/colors.py b/docs/colors.py similarity index 100% rename from doc/colors.py rename to docs/colors.py diff --git a/doc/custom_level.py b/docs/custom_level.py similarity index 100% rename from doc/custom_level.py rename to docs/custom_level.py diff --git a/doc/example.png b/docs/example.png similarity index 100% rename from doc/example.png rename to docs/example.png diff --git a/doc/example.py b/docs/example.py similarity index 100% rename from doc/example.py rename to docs/example.py diff --git a/doc/yaml_example.py b/docs/yaml_example.py similarity index 100% rename from doc/yaml_example.py rename to docs/yaml_example.py diff --git a/doc/yaml_example.yaml b/docs/yaml_example.yaml similarity index 100% rename from doc/yaml_example.yaml rename to docs/yaml_example.yaml diff --git a/tox.ini b/tox.ini index a8d1d5f..a918a2b 100644 --- a/tox.ini +++ b/tox.ini @@ -7,17 +7,17 @@ commands = pytest -v [testenv:black] deps = black -commands = black --check --diff colorlog doc +commands = black --check --diff colorlog docs skip_install = true [testenv:flake8] deps = flake8 -commands = flake8 colorlog doc +commands = flake8 colorlog docs skip_install = true [testenv:mypy] deps = mypy types-PyYAML -commands = mypy colorlog doc +commands = mypy colorlog docs skip_install = true