Skip to content

Commit 80f3864

Browse files
healkeiserhealkeiser
committed
[DOC] Added files for MkDocs
1 parent 93cc27d commit 80f3864

File tree

9 files changed

+283
-4
lines changed

9 files changed

+283
-4
lines changed

‎CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,12 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
99

1010
## [Unreleased](https://github.com/healkeiser/fxlog/compare/v0.1.1...HEAD)
1111

12+
### Commits
13+
14+
- [FEATURE] Add FXColorLogger, color constants, shared file handler, expanded examples [`d693520`](https://github.com/healkeiser/fxlog/commit/d693520031cbea2252d000615e2aea874d9cac58)
15+
- [BUILD] Added files for new CI [`421f52f`](https://github.com/healkeiser/fxlog/commit/421f52fcb2a1ae889afa183f2e4ef7738e8ff48c)
16+
- [FIX] Calling set_loggers_level will also impact newly created loggers [`93cc27d`](https://github.com/healkeiser/fxlog/commit/93cc27dd90b5ce12fcf774f6cd9e72b7e18dec59)
17+
1218
## [v0.1.1](https://github.com/healkeiser/fxlog/compare/v0.1.0...v0.1.1) - 2024-12-03
1319

1420
### Commits

‎docs/fxlogger.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
::: fxlog.fxlogger

‎docs/images/fxlog_logo_background_dark.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎docs/images/fxlog_logo_background_light.svg‎

Lines changed: 1 addition & 0 deletions
Loading

‎docs/index.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# :material-home:{.scale-in-center} Home
2+
3+
<div id="top"></div>
4+
<div align="center">
5+
<a href="https://github.com/healkeiser/fxlog">
6+
<img src="docs/images/fxlog_logo_background_dark.svg" alt="fxlog" width="128" >
7+
</a>
8+
<p align="center">
9+
<br/>
10+
</p>
11+
</div>
12+
13+
## What is fxgui
14+
15+
A custom logging module for Python that supports colorized output and log file rotation.
16+
17+
!!! note
18+
This documentation is updated regularly to reflect the most recent changes.<br>
19+
If you spot any issue or have a feature request, don't hesitate to send me an [email](mailto:valentin.onze@gmail.com).

‎docs/installation.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# :material-download:{.scale-in-center} Installation
2+
3+
## Installation
4+
5+
The package is available on [PyPI](https://pypi.org/project/fxlog).
6+
7+
``` shell
8+
pip install fxlog
9+
```
10+

‎docs/stylesheets/extra.css‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
@keyframes scale-in-center {
2+
0% {
3+
transform: scale(0);
4+
opacity: 1
5+
}
6+
7+
100% {
8+
transform: scale(1);
9+
opacity: 1
10+
}
11+
}
12+
13+
.scale-in-center {
14+
animation: scale-in-center .5s cubic-bezier(.25, .46, .45, .94) both
15+
}
16+
17+
/* Custom color overrides */
18+
:root>* {
19+
/* Accent color shades */
20+
--md-accent-fg-color: #2196F3;
21+
--md-accent-fg-color--transparent: #2196F310;
22+
--md-accent-bg-color: #2196F3;
23+
--md-accent-bg-color--light: #2196F310;
24+
25+
/* Typeset `a` color shades */
26+
--md-typeset-a-color: #2196F3;
27+
}
28+
29+
/* Black primary color overrides */
30+
[data-md-color-primary="black"] {
31+
/* Primary color shades */
32+
--md-primary-fg-color: #212121;
33+
--md-primary-fg-color--light: #212121;
34+
--md-primary-fg-color--dark: #212121;
35+
36+
/* Typeset `a` color shades */
37+
--md-typeset-a-color: #2196F3;
38+
}
39+
40+
/* Light mode (default scheme) overrides */
41+
[data-md-color-scheme="default"][data-md-color-primary="black"] {
42+
43+
/* Header */
44+
.md-header {
45+
background-color: #151515;
46+
}
47+
48+
/* Navigation tabs */
49+
.md-tabs {
50+
background-color: #151515;
51+
}
52+
53+
/* Footer */
54+
.md-footer {
55+
background-color: #151515;
56+
}
57+
}
58+
59+
/* Dark mode (slate scheme) overrides */
60+
[data-md-color-scheme="slate"][data-md-color-primary="black"] {
61+
/* Primary color shades */
62+
--md-primary-fg-color: #212121;
63+
--md-primary-fg-color--light: #212121;
64+
--md-primary-fg-color--dark: #212121;
65+
66+
/* Default color shades */
67+
--md-default-bg-color: #201f1f;
68+
--md-default-bg-color--light: #201f1f;
69+
--md-default-bg-color--lighter: #201f1f;
70+
--md-default-bg-color--lightest: #201f1f;
71+
72+
/* Footer color shades */
73+
--md-footer-bg-color: #151515;
74+
--md-footer-bg-color--dark: #151515;
75+
76+
/* Typeset `a` color shades */
77+
--md-typeset-a-color: #2196F3;
78+
79+
/* Header */
80+
.md-header {
81+
background-color: #151515;
82+
}
83+
84+
/* Navigation tabs */
85+
.md-tabs {
86+
background-color: #151515;
87+
}
88+
89+
/* Main content area */
90+
.md-main {
91+
background-color: #201f1f;
92+
}
93+
94+
/* Sidebar */
95+
.md-sidebar {
96+
background-color: #201f1f;
97+
}
98+
99+
/* Content container */
100+
.md-content {
101+
background-color: #201f1f;
102+
}
103+
104+
/* Footer */
105+
.md-footer {
106+
background-color: #151515 !important;
107+
}
108+
}
109+
110+
/* Link hover effects */
111+
.md-typeset a:hover,
112+
.md-typeset a:focus,
113+
.md-nav__link:hover,
114+
.md-nav__link:focus {
115+
color: #1976D2 !important;
116+
}

‎fxlog/fxlogger.py‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -458,14 +458,13 @@ def configure_logger(
458458

459459

460460
def set_loggers_level(level: int) -> None:
461-
"""Sets the logging level for all loggers created with configure_logger.
462-
461+
"""Sets the logging level for all loggers created with `configure_logger`.
463462
This affects both existing loggers and any loggers created after this
464463
call.
465464
466465
Args:
467-
level (int): The logging level to set (e.g., logging.DEBUG,
468-
logging.INFO).
466+
level (int): The logging level to set (e.g., fxlogger.DEBUG,
467+
fxlogger.INFO).
469468
470469
Examples:
471470
>>> from fxlog import fxlogger

‎mkdocs.yml‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,126 @@
1+
# Base for MkDocs.
2+
3+
# Author: Valentin Beaumont
4+
# Mail: valentin.onze@gmail.com
5+
6+
site_name: fxlog
7+
site_author: Valentin Beaumont
8+
copyright: Valentin Beaumont | Licensed under the MIT License
9+
repo_url: https://github.com/healkeiser/fxlog
10+
repo_name: healkeiser/fxlog
11+
edit_uri: edit/main/docs/
12+
13+
###### Custom ##################################################################
14+
15+
extra_css:
16+
- stylesheets/extra.css
17+
18+
###### Theme ###################################################################
19+
20+
theme:
21+
name: material
22+
language: en
23+
favicon: images/fxlog_logo_background_light.svg
24+
logo: images/fxlog_logo_background_dark.svg
25+
icon:
26+
repo: material/github
27+
features:
28+
- announce.dismiss
29+
- navigation.tabs
30+
- navigation.sections
31+
- navigation.expand
32+
- navigation.top
33+
- content.code.annotate
34+
- content.tooltips
35+
- content.tabs.link
36+
- content.action.edit
37+
palette:
38+
# Light mode
39+
- media: "(prefers-color-scheme: light)"
40+
scheme: default
41+
primary: black
42+
accent: blue
43+
toggle:
44+
icon: material/brightness-7
45+
name: Switch to dark mode
46+
# Dark mode
47+
- media: "(prefers-color-scheme: dark)"
48+
scheme: slate
49+
primary: black
50+
accent: blue
51+
toggle:
52+
icon: material/brightness-4
53+
name: Switch to light mode
54+
55+
###### Markdown extensions #####################################################
56+
57+
markdown_extensions:
58+
- footnotes
59+
- admonition
60+
- attr_list
61+
- md_in_html
62+
- def_list
63+
- tables
64+
- pymdownx.details
65+
- pymdownx.inlinehilite
66+
- pymdownx.snippets
67+
- pymdownx.superfences
68+
- pymdownx.critic
69+
- pymdownx.caret
70+
- pymdownx.keys
71+
- pymdownx.mark
72+
- pymdownx.tilde
73+
- pymdownx.b64
74+
- pymdownx.smartsymbols
75+
- pymdownx.highlight:
76+
anchor_linenums: true
77+
- pymdownx.tasklist:
78+
custom_checkbox: true
79+
- pymdownx.tabbed:
80+
alternate_style: true
81+
- pymdownx.emoji:
82+
emoji_index: !!python/name:material.extensions.emoji.twemoji
83+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
84+
85+
plugins:
86+
- search
87+
- git-authors
88+
- git-revision-date-localized:
89+
enable_creation_date: true
90+
- git-committers:
91+
repository: healkeiser/fxgui
92+
branch: main
93+
# token: !!python/object/apply:os.getenv ["GITHUB_API_KEY"]
94+
- mkdocstrings:
95+
enabled: !ENV [ENABLE_MKDOCSTRINGS, true]
96+
# custom_templates: templates
97+
handlers:
98+
python:
99+
options:
100+
# paths: [src]
101+
heading_level: 2
102+
show_symbol_type_heading: true
103+
show_symbol_type_toc: true
104+
separate_signature: true
105+
parameter_headings: true
106+
line_length: 80
107+
show_signature_annotations: true
108+
signature_crossrefs: true
109+
docstring_style: google
110+
docstring_section_style: table
111+
show_if_no_docstring: false
112+
show_docstring_attributes: true
113+
annotations_path: brief
114+
show_root_heading: false
115+
show_root_full_path: false
116+
show_source: false
117+
find_stubs_package: true
118+
summary: true
119+
120+
###### Navigation ##############################################################
121+
122+
nav:
123+
- Home: index.md
124+
- Installation: installation.md
125+
- Technical:
126+
- fxlogger: fxlogger.md

0 commit comments

Comments
 (0)