Skip to content

Commit 3e4ba91

Browse files
committed
Migrate docs to MkDocs with Material theme
Replaces Sphinx with MkDocs, adopting the Material theme for documentation. Updates CI workflows and invoke tasks for MkDocs commands. Converts 73 RST files to Markdown and removes RST directives from Python docstrings. Enhances API documentation using mkdocstrings to parse NumPy-style docstrings.
1 parent cefa018 commit 3e4ba91

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Added
1111

12+
- MkDocs + Material theme based docs
13+
1214
### Changed
1315

16+
- update CI workflow for mkdocs gh-deploy
17+
- update invoke tasks for mkdocs commands
18+
1419
### Removed
1520

21+
- replace Sphinx with MkDocs + Material theme
22+
- use mkdocstrings for API docs from NumPy docstrings
23+
- convert 73 RST files to Markdown
24+
- remove RST directives from Python docstrings
1625

1726
## [2.15.0] 2025-11-12
1827

0 commit comments

Comments
 (0)