Skip to content

Commit

Permalink
docs: update documentation for clarity and consistency
Browse files Browse the repository at this point in the history
- Clarifies configuration options in the documentation
- Ensures consistent formatting across documentation files
- Adds missing sections for newly introduced features
  • Loading branch information
liblaf committed Dec 16, 2024
1 parent f31a6ec commit 0005523
Show file tree
Hide file tree
Showing 3 changed files with 719 additions and 709 deletions.
66 changes: 33 additions & 33 deletions requirements-dev.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
# uv export --all-extras --no-hashes --output-file requirements-dev.lock
-e .
annotated-types==0.7.0
anyio==4.6.2.post1
asttokens==2.4.1
anyio==4.7.0
asttokens==3.0.0
babel==2.16.0
black==24.10.0
boltons==24.0.0
boltons==24.1.0
cairocffi==1.7.1
cairosvg==2.7.1
certifi==2024.8.30
certifi==2024.12.14
cffi==1.17.1
charset-normalizer==3.4.0
click==8.1.7
Expand All @@ -21,22 +21,22 @@ executing==2.1.0
ghp-import==2.1.0
gitdb==4.0.11
gitpython==3.1.43
griffe==1.4.1
griffe==1.5.1
h11==0.14.0
httpcore==1.0.6
httpx==0.27.2
httpcore==1.0.7
httpx==0.28.1
humanize==4.11.0
icecream==2.1.3
idna==3.10
itsdangerous==2.2.0
jedi==0.19.1
jedi==0.19.2
jinja2==3.1.4
lazy-loader==0.4
loguru==0.7.2
marimo==0.9.10
loguru==0.7.3
marimo==0.10.2
markdown==3.7
markdown-it-py==3.0.0
markupsafe==3.0.1
markupsafe==3.0.2
mdurl==0.1.2
mergedeep==1.3.4
mkdocs==1.6.1
Expand All @@ -45,50 +45,50 @@ mkdocs-embed-external-markdown==3.0.2
mkdocs-gen-files==0.5.0
mkdocs-get-deps==0.2.0
mkdocs-git-committers-plugin-2==2.4.1
mkdocs-git-revision-date-localized-plugin==1.2.9
mkdocs-git-revision-date-localized-plugin==1.3.0
mkdocs-literate-nav==0.6.1
mkdocs-material==9.5.41
mkdocs-material==9.5.49
mkdocs-material-extensions==1.3.1
mkdocs-section-index==0.3.9
mkdocstrings==0.26.2
mkdocstrings-python==1.12.1
mkdocstrings==0.27.0
mkdocstrings-python==1.12.2
mypy-extensions==1.0.0
narwhals==1.9.3
packaging==24.1
narwhals==1.18.4
packaging==24.2
paginate==0.5.7
parso==0.8.4
pathspec==0.12.1
pillow==10.4.0
platformdirs==4.3.6
prettytable==3.11.0
psutil==6.0.0
prettytable==3.12.0
psutil==6.1.0
pycparser==2.22
pydantic==2.9.2
pydantic-core==2.23.4
pydantic==2.10.3
pydantic-core==2.27.1
pygments==2.18.0
pymdown-extensions==10.11.2
pymdown-extensions==10.12
python-dateutil==2.9.0.post0
pytz==2024.2
pyyaml==6.0.2
pyyaml-env-tag==0.1
regex==2024.9.11
regex==2024.11.6
requests==2.32.3
rich==13.9.2
ruff==0.6.9
six==1.16.0
rich==13.9.4
ruff==0.8.3
six==1.17.0
smmap==5.0.1
sniffio==1.3.1
socksio==1.0.0
starlette==0.41.0
tinycss2==1.3.0
starlette==0.42.0
tinycss2==1.4.0
tomlkit==0.13.2
typing-extensions==4.12.2
ubelt==1.3.6
ubelt==1.3.7
urllib3==2.2.3
uvicorn==0.32.0
uvicorn==0.34.0
validators==0.34.0
watchdog==5.0.3
watchdog==6.0.0
wcwidth==0.2.13
webencodings==0.5.1
websockets==12.0
win32-setctime==1.1.0 ; sys_platform == 'win32'
websockets==14.1
win32-setctime==1.2.0 ; sys_platform == 'win32'
48 changes: 24 additions & 24 deletions requirements.lock
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
# uv export --all-extras --no-dev --no-hashes --output-file requirements.lock
-e .
annotated-types==0.7.0
anyio==4.6.2.post1
anyio==4.7.0
babel==2.16.0
black==24.10.0
boltons==24.0.0
boltons==24.1.0
cairocffi==1.7.1
cairosvg==2.7.1
certifi==2024.8.30
certifi==2024.12.14
cffi==1.17.1
charset-normalizer==3.4.0
click==8.1.7
Expand All @@ -18,18 +18,18 @@ defusedxml==0.7.1
ghp-import==2.1.0
gitdb==4.0.11
gitpython==3.1.43
griffe==1.4.1
griffe==1.5.1
h11==0.14.0
httpcore==1.0.6
httpx==0.27.2
httpcore==1.0.7
httpx==0.28.1
humanize==4.11.0
idna==3.10
jinja2==3.1.4
lazy-loader==0.4
loguru==0.7.2
loguru==0.7.3
markdown==3.7
markdown-it-py==3.0.0
markupsafe==3.0.1
markupsafe==3.0.2
mdurl==0.1.2
mergedeep==1.3.4
mkdocs==1.6.1
Expand All @@ -38,42 +38,42 @@ mkdocs-embed-external-markdown==3.0.2
mkdocs-gen-files==0.5.0
mkdocs-get-deps==0.2.0
mkdocs-git-committers-plugin-2==2.4.1
mkdocs-git-revision-date-localized-plugin==1.2.9
mkdocs-git-revision-date-localized-plugin==1.3.0
mkdocs-literate-nav==0.6.1
mkdocs-material==9.5.41
mkdocs-material==9.5.49
mkdocs-material-extensions==1.3.1
mkdocs-section-index==0.3.9
mkdocstrings==0.26.2
mkdocstrings-python==1.12.1
mkdocstrings==0.27.0
mkdocstrings-python==1.12.2
mypy-extensions==1.0.0
packaging==24.1
packaging==24.2
paginate==0.5.7
pathspec==0.12.1
pillow==10.4.0
platformdirs==4.3.6
prettytable==3.11.0
prettytable==3.12.0
pycparser==2.22
pydantic==2.9.2
pydantic-core==2.23.4
pydantic==2.10.3
pydantic-core==2.27.1
pygments==2.18.0
pymdown-extensions==10.11.2
pymdown-extensions==10.12
python-dateutil==2.9.0.post0
pytz==2024.2
pyyaml==6.0.2
pyyaml-env-tag==0.1
regex==2024.9.11
regex==2024.11.6
requests==2.32.3
rich==13.9.2
six==1.16.0
rich==13.9.4
six==1.17.0
smmap==5.0.1
sniffio==1.3.1
socksio==1.0.0
tinycss2==1.3.0
tinycss2==1.4.0
typing-extensions==4.12.2
ubelt==1.3.6
ubelt==1.3.7
urllib3==2.2.3
validators==0.34.0
watchdog==5.0.3
watchdog==6.0.0
wcwidth==0.2.13
webencodings==0.5.1
win32-setctime==1.1.0 ; sys_platform == 'win32'
win32-setctime==1.2.0 ; sys_platform == 'win32'
Loading

0 comments on commit 0005523

Please sign in to comment.