final commit 2

scikit-learn-contrib · Jan 9, 2025 · f82f41e · f82f41e
1 parent 2e6e12e
commit f82f41e
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -24,8 +24,9 @@ Please describe the tests that you ran to verify your changes. Provide instructi
 
 - [ ] I have read the [contributing guidelines](https://github.com/scikit-learn-contrib/MAPIE/blob/master/CONTRIBUTING.rst)
 - [ ] I have updated the [HISTORY.rst](https://github.com/scikit-learn-contrib/MAPIE/blob/master/HISTORY.rst) and [AUTHORS.rst](https://github.com/scikit-learn-contrib/MAPIE/blob/master/AUTHORS.rst) files
-- [ ] Linting passes successfully : `make lint`
-- [ ] Typing passes successfully : `make type-check`
-- [ ] Unit tests pass successfully : `make tests`
-- [ ] Coverage is 100% : `make coverage`
-- [ ] Documentation builds successfully and without warnings : `make doc`
+- [ ] Linting passes successfully: `make lint`
+- [ ] Typing passes successfully: `make type-check`
+- [ ] Unit tests pass successfully: `make tests`
+- [ ] Coverage is 100%: `make coverage`
+- [ ] When updating documentation: doc builds successfully and without warnings: `make doc`
+- [ ] When updating documentation: code examples in doc run successfully: `make doctest`
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -15,6 +15,7 @@ History
 * Limit max sklearn version allowed at MAPIE installation
 * Refactor MapieRegressor, EnsembleRegressor, and MapieQuantileRegressor, to prepare for the release of v1.0.0
 * Documentation build: fix warnings, fix image generation, update sklearn version requirement
+* Documentation test: add a doc testing step (in MAKEFILE and CI)
 * Increase max line length from 79 to 88 characters
 * Bump wheel version
 

diff --git a/Makefile b/Makefile
@@ -22,6 +22,9 @@ coverage:
 doc:
 	$(MAKE) html -C doc
 
+doctest:
+	$(MAKE) doctest -C doc
+
 clean-doc:
 	$(MAKE) clean -C doc