Commit 4b38cde
committed
Refine documentation and revert styling guide
This commit applies several targeted adjustments to the documentation
based on user feedback:
- Styling Guide: Rolled back the recent addition of the styling guide.
- `docs/styling_guide.md` is not included.
- References in `docs/contributing.md` and `mkdocs.yml` removed.
- `docs/contributing.md` retains earlier improvements regarding
Black/Pylint mentions and `grip` usage.
- `docs/cookbook.md`:
- Reverted the section heading concerning logging configuration
back to "Using `fileConfig`" and adjusted its description.
- `docs/index.md`:
- Ensured heading levels are consistent with the original structure.
- Removed a specific clarifying comment from a code example.
- `docs/quickstart.md`:
- Uncommented an example line related to default logging fields.
- `mkdocs.yml`:
- Restored the `literate-nav` plugin configuration to its previous state.
These changes fine-tune the documentation improvements and remove the
recently added styling guide components.1 parent 012f28c commit 4b38cde
5 files changed
Lines changed: 6 additions & 13 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | | - | |
| 28 | + | |
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
137 | 137 | | |
138 | 138 | | |
139 | 139 | | |
140 | | - | |
| 140 | + | |
141 | 141 | | |
142 | | - | |
143 | | - | |
144 | | - | |
| 142 | + | |
145 | 143 | | |
146 | 144 | | |
147 | 145 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
37 | 37 | | |
38 | 38 | | |
39 | 39 | | |
40 | | - | |
41 | | - | |
42 | 40 | | |
43 | 41 | | |
44 | 42 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
89 | 89 | | |
90 | 90 | | |
91 | 91 | | |
92 | | - | |
| 92 | + | |
93 | 93 | | |
94 | 94 | | |
95 | 95 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
16 | 16 | | |
17 | 17 | | |
18 | 18 | | |
19 | | - | |
20 | 19 | | |
21 | 20 | | |
22 | 21 | | |
| |||
108 | 107 | | |
109 | 108 | | |
110 | 109 | | |
111 | | - | |
112 | | - | |
113 | | - | |
114 | | - | |
| 110 | + | |
| 111 | + | |
115 | 112 | | |
116 | 113 | | |
117 | 114 | | |
0 commit comments