ci: add GitHub Action to build and validate documentation - #490
Merged
Conversation
apaleyes
reviewed
Jul 26, 2026
| push: | ||
| branches: [ main ] | ||
| pull_request: | ||
| branches: [ main ] |
apaleyes
reviewed
Jul 26, 2026
apaleyes
reviewed
Jul 26, 2026
apaleyes-bot
force-pushed
the
add-docs-build-workflow
branch
2 times, most recently
from
July 26, 2026 16:09
cfb95b4 to
9c6b564
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #490 +/- ##
==========================================
+ Coverage 89.10% 89.24% +0.13%
==========================================
Files 137 137
Lines 4847 4861 +14
Branches 479 477 -2
==========================================
+ Hits 4319 4338 +19
+ Misses 402 396 -6
- Partials 126 127 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Add a minimal 'Build docs' workflow that runs on every push and pull request to ensure Sphinx documentation builds without errors. This catches: - Missing or broken Sphinx directives - Broken cross-references - Missing doc dependencies - Documentation build failures early in the CI process Co-authored-by: Andrei Paleyes <2852301+apaleyes@users.noreply.github.com>
apaleyes-bot
force-pushed
the
add-docs-build-workflow
branch
from
July 26, 2026 17:04
9c6b564 to
a3b14cb
Compare
apaleyes-bot
force-pushed
the
add-docs-build-workflow
branch
6 times, most recently
from
July 26, 2026 20:28
07f85e1 to
6067bee
Compare
apaleyes
reviewed
Jul 26, 2026
Fix docstring indentation and formatting issues: - gpy_model_wrappers.py: Fix indentation in get_covariance_between_points - convert_lists_to_array.py: Fix docstring indentation for convert_y_list_to_array and convert_xy_lists_to_arrays - non_linear_multi_fidelity_model.py: Fix math directive spacing in make_non_linear_kernels Fix reStructuredText formatting: - outer_loop.py: Fix inline code markup (backticks) in docstring - installation.rst: Fix title underlines and code block indentation - emukit.quadrature.measures.rst: Fix title underline length Fix cross-references and missing documents: - tutorials.rst: Fix references to nonexistent notebook names (add 'tutorial-' prefix) - local_search_acquisition_optimizer.py: Remove duplicate footnote labels - wsabi.py: Remove duplicate footnote reference labels - sixhumpcamel.py: Fix math directive spacing and formula typo (= -> +) Fix notebook formatting: - Emukit-tutorial-Bayesian-quadrature-introduction.ipynb: Fix inconsistent heading levels (#### -> ###) These changes resolve all 66 documentation warnings/errors reported by Sphinx with -W flag. Co-authored-by: Andrei Paleyes <2852301+apaleyes@users.noreply.github.com>
apaleyes-bot
force-pushed
the
add-docs-build-workflow
branch
from
July 26, 2026 21:30
6067bee to
87b32d0
Compare
apaleyes
approved these changes
Jul 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a minimal 'Build docs' workflow that runs on every push and pull request to ensure Sphinx documentation builds without errors.
What this catches
Workflow details
make htmlin the doc directory