Skip to content

Commit 689a9cb

Browse files
committed
Big docs/testing cleanup
1 parent faca4d1 commit 689a9cb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

77 files changed

+3364
-2520
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 🚀 Changelog
1+
# Changelog
22

33
## 0.10.0 (2026-??-??)
44

Makefile

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@ init:
77
.PHONY: typecheck
88
typecheck:
99
mypy pysrc/ tests/
10-
pytest --mypy-ini-file=tests/mypy.ini typesafety/
1110

1211
.PHONY: format
1312
format:
@@ -18,7 +17,7 @@ format:
1817
.PHONY: docs
1918
docs:
2019
rm -f pysrc/whenever/*.so # Presence of the rust extension breaks sphinx (TODO: a better workaround)
21-
@touch docs/api.rst # force rebuild of API docs: code changes aren't detected
20+
rm -rf docs/_build/
2221
make -C docs/ html
2322

2423
.PHONY: check-readme

docs/Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
# You can set these variables from the command line.
55
SPHINXOPTS =
66
SPHINXBUILD = sphinx-build
7-
SPHINXPROJ = Quiz
7+
SPHINXPROJ = Whenever
88
SOURCEDIR = .
99
BUILDDIR = _build
1010

@@ -17,4 +17,4 @@ help:
1717
# Catch-all target: route all unknown targets to Sphinx using the new
1818
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
1919
%: Makefile
20-
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/api.rst

Lines changed: 0 additions & 219 deletions
This file was deleted.

docs/changelog.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../CHANGELOG.md
2+
```

docs/changelog.rst

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/conf.py

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,6 @@
2525
"sphinx.ext.napoleon",
2626
"sphinx.ext.viewcode",
2727
"sphinx_copybutton",
28-
"enum_tools.autoenum",
2928
"myst_parser",
3029
]
3130
templates_path = ["_templates"]
@@ -34,14 +33,21 @@
3433
".rst": "restructuredtext",
3534
}
3635
html_static_path = ["_static"]
36+
html_title = "Whenever"
3737

3838
master_doc = "index"
3939
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
4040
myst_heading_anchors = 2
41+
myst_enable_extensions = [
42+
"colon_fence",
43+
"smartquotes",
44+
]
4145

4246
# -- Options for HTML output ----------------------------------------------
4347

44-
autodoc_member_order = "bysource"
48+
autodoc_default_options = {
49+
"exclude-members": "__weakref__, __init__, __init_subclass__, __reduce__, __hash__, __repr__",
50+
}
4551
html_theme = "furo"
4652
highlight_language = "python3"
4753
pygments_style = "default"
@@ -50,3 +56,8 @@
5056
"python": ("https://docs.python.org/3", None),
5157
}
5258
toc_object_entries_show_parents = "hide"
59+
maximum_signature_line_length = 95
60+
# Awaiting https://github.com/sphinx-doc/sphinx/issues/14003
61+
# autodoc_type_aliases = {
62+
# "_CalendarUnitPlural": "_CalendarUnitPlural",
63+
# }

docs/contributing.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
```{include} ../CONTRIBUTING.md
2+
```

0 commit comments

Comments
 (0)