Skip to content

Added GH icon to docs footer #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nikosarcevic merged 3 commits into from
Jun 30, 2026
Merged

Added GH icon to docs footer #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
65bfa62
added gh icon to conf, updated icon colors in static
nikosarcevic Jun 30, 2026
01cc827
fixed numpy type ci fail in tests
nikosarcevic Jun 30, 2026
967b5d1
added py 3.13 CI
nikosarcevic Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ jobs:
strategy:
fail-fast: false
matrix:
python-version: ["3.10", "3.11", "3.12"]
python-version: ["3.10", "3.11", "3.12", "3.13"]

steps:
- name: Checkout
Expand Down
12 changes: 12 additions & 0 deletions docs/_static/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,4 +139,16 @@ h3:hover .headerlink {

.sidebar-tree a {
padding: 0.15rem 0;
}

/* ==========================================================================
LFKit — Footer icons
========================================================================== */

.lfkit-github-icon svg {
color: #FE5019; /* LFKit red */
}

.lfkit-github-icon:hover svg {
color: #28A8C8; /* LFKit blue */
}
35 changes: 35 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,9 +72,44 @@
html_static_path = ["_static"]

html_theme_options = {
"source_repository": "https://github.com/cosmo-hub/lfkit/",
"source_branch": "main",
"source_directory": "docs/",

"light_logo": "logos/lfkit_logo-icon.png",
"dark_logo": "logos/lfkit_logo-icon.png",

"footer_icons": [
{
"name": "GitHub",
"url": "https://github.com/cosmo-hub/lfkit",
"html": """
<svg stroke="currentColor" fill="currentColor" stroke-width="0"
viewBox="0 0 16 16">
style="color: #FE5019;">
<path d="M8 0C3.58 0 0 3.58 0 8c0 3.54
2.29 6.53 5.47 7.59.4.07.55-.17.55-.38
0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49
-2.69-.94-.09-.23-.48-.94-.82-1.13
-.28-.15-.68-.52-.01-.53.63-.01 1.08.58
1.23.82.72 1.21 1.87.87 2.33.66
.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89
-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2
-.36-1.02.08-2.12 0 0 .67-.21 2.2.82
A7.65 7.65 0 0 1 8 3.87c.68 0 1.36.09
2 .26 1.53-1.04 2.2-.82 2.2-.82.44
1.1.16 1.92.08 2.12.51.56.82 1.27.82
2.15 0 3.07-1.87 3.75-3.65 3.95.29
.25.54.73.54 1.48 0 1.07-.01 1.93-.01
2.2 0 .21.15.46.55.38A8.013 8.013
0 0 0 16 8c0-4.42-3.58-8-8-8z">
</path>
</svg>
""",
"class": "lfkit-github-icon",
},
],

"light_css_variables": {
"color-brand-primary": "#28A8C8",
"color-brand-content": "#28A8C8",
Expand Down
8 changes: 4 additions & 4 deletions tests/test_utils_types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
from typing import Any, get_args, get_origin

import numpy as np
from numpy.typing import NDArray

import lfkit.utils.types as lf_types

Expand All @@ -25,10 +26,9 @@ def test_types_exports_expected_public_names() -> None:
assert set(lf_types.__all__) == expected


def test_float_array_alias_points_to_numpy_ndarray() -> None:
"""Tests that FloatArray aliases a NumPy ndarray type."""
assert get_origin(lf_types.FloatArray) is np.ndarray
assert "float64" in str(lf_types.FloatArray)
def test_float_array_alias_is_float64_ndarray() -> None:
"""Tests that FloatArray is a NumPy float64 array typing alias."""
assert lf_types.FloatArray == NDArray[np.float64]


def test_float_input_includes_expected_user_input_forms() -> None:
Expand Down
Loading