Document the header layout migration and update README examples - #2940
Merged
JohanMabille merged 1 commit intoOct 16, 2026
Merged
JohanMabille merged 1 commit into
JohanMabille merged 1 commit into
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
JohanMabille
approved these changes
Oct 16, 2026
JohanMabille
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Thanks!
Sorry, something went wrong.
Copy link
Copy Markdown
Member
|
Documentation only, no need to run the CI. |
Sorry, something went wrong.
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
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.
Checklist
Description
Fixes #2851.
Users upgrading from 0.25 encounter missing headers such as xtensor/xarray.hpp, including in the README examples. Add an installation-guide section with common old/new paths, guidance for locating other headers and keeping the correct include search root, and the C++/xtl requirements across the transition. Update the README examples and the documentation index's obsolete C++14 requirement.
Validated all three README examples with GCC 15 and Clang 21 against 0.26 (C++17) and current master (C++20), using xtl 0.8.0. Original includes fail in all twelve combinations; updated examples compile and produce the expected numerical results. Checked all sixteen mappings against 0.25, 0.26 and current headers. Changed-file pre-commit checks pass.
Built the HTML documentation with Doxygen 1.15 and Sphinx: the final build and unmodified baseline produce the same fifteen warnings, so neither passes warnings-as-errors. Verified both new link anchors in generated HTML. Full C++ unit tests and other platforms were not run for this documentation change.
Prepared with OpenAI Codex assistance.