Skip to content

Commit 404c129

Browse files
committed
Fix doc
1 parent 99883e8 commit 404c129

7 files changed

Lines changed: 322 additions & 119 deletions

File tree

docs/Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
11
# Makefile for Krum documentation
22

3-
.PHONY: help html clean servedocs live watch
3+
.PHONY: help html build clean serve watch
44

55
help:
66
@echo "Available targets:"
77
@echo " html - Build HTML documentation"
8+
@echo " build - Build HTML documentation (alias for html)"
89
@echo " clean - Remove generated files"
910
@echo " serve - Build and serve static documentation"
1011
@echo " watch - Watch for changes and serve (auto-rebuild)"
1112

1213
html:
1314
uv run sphinx-build -b html . _build/html
1415

16+
build: html
17+
1518
clean:
1619
rm -rf _build
1720

docs/_static/custom.css

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,9 @@
1616

1717
.bd-toc .page-toc + .sidebar-secondary-item {
1818
display: none;
19+
}
20+
21+
/* Contributions Avatar */
22+
.sphinx-contributors img {
23+
border-radius: 50%;
1924
}

docs/conf.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,16 @@
66
# -- Project information -----------------------------------------------------
77
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
88

9+
import importlib
910
import os
1011
import sys
1112

1213
sys.path.insert(0, os.path.abspath(".."))
1314

15+
# Make krum submodules available as top-level imports for autodoc compatibility
16+
for _mod in ("aggregators", "attacks", "experiments", "native", "tools"):
17+
sys.modules[_mod] = importlib.import_module(f"krum.{_mod}")
18+
1419
project = "Krum, the Library"
1520
copyright = "2026"
1621
author = "Peva BLANCHARD, Arthur DANJOU, El-Mahdi EL-MHAMDI, Sébastien ROUAULT, Mohammed Ammar SAID"

docs/contributors.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@ Contributors
33

44
The following people have contributed to Krum:
55

6-
.. container:: rounded-image
7-
.. contributors:: calicarpa/krum
8-
:avatars:
6+
.. contributors:: calicarpa/krum
7+
:avatars:
8+
:names:
99

1010
We are open to all contributions. Whether it is a bug fix, a new feature, or an improvement to the documentation, feel free to open a pull request or start a discussion on GitHub.
1111

docs/how-to/add-dataset.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ batching automatically.
7272
)
7373
7474
Step 3 — Export in ``__all__``
75-
-----------------------------
75+
------------------------------
7676

7777
List the builder function in ``__all__`` so the loader can discover it.
7878

pyproject.toml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,8 @@ quote-style = "double"
103103
indent-style = "space"
104104
skip-magic-trailing-comma = false
105105
line-ending = "auto"
106+
107+
[dependency-groups]
108+
dev = [
109+
"sphinx-autobuild>=2024.10.3",
110+
]

uv.lock

Lines changed: 299 additions & 114 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)