Skip to content

Commit

Permalink
🔀 Merge pull request #90 from astariul/upgrade_mkdocstring
Browse files Browse the repository at this point in the history
Upgrade mkdocstring
  • Loading branch information
astariul authored Mar 21, 2024
2 parents de140bf + 7213f6e commit 9f081b1
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 4 deletions.
2 changes: 1 addition & 1 deletion docs/code_ref.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# pytere

::: pytere
rendering:
options:
show_root_heading: False
show_root_toc_entry: False
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ theme:
favicon: "assets/flame.svg"
features:
- navigation.sections
- content.code.copy
palette:
- scheme: default
primary: teal
Expand All @@ -25,6 +26,7 @@ theme:

markdown_extensions:
- admonition
- tables
- pymdownx.details
- pymdownx.caret
- pymdownx.keys
Expand All @@ -43,9 +45,10 @@ nav:
plugins:
- search
- mkdocstrings:
default_handler: python
handlers:
python:
rendering:
options:
show_root_heading: True
show_root_full_path: False
members_order: source
Expand Down
2 changes: 1 addition & 1 deletion pytere/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ def is_odd(x: float) -> bool:
x (float): Number to check.
Returns:
bool: True if the number is odd, False otherwise.
True if the number is odd, False otherwise.
"""
return x % 2 == 1
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
"test": ["pytest~=8.0", "pytest-cov~=4.1", "coverage-badge~=1.0"],
"hook": ["pre-commit~=3.0"],
"lint": ["ruff~=0.2"],
"docs": ["mkdocs-material~=9.0", "mkdocstrings[python]~=0.18", "mike~=2.0"],
"docs": ["mkdocs-material~=9.0", "mkdocstrings[python]~=0.24", "mike~=2.0"],
}
extras_require["all"] = sum(extras_require.values(), [])
extras_require["dev"] = (
Expand Down

0 comments on commit 9f081b1

Please sign in to comment.