fix(pages): create doxygen output dir and remove obsolete CLASS_DIAGRAMS - #25
Merged
Conversation
- mkdir -p _doxygen/xml before running doxygen (directory doesn't exist on a fresh CI checkout and doxygen won't create it automatically) - Remove CLASS_DIAGRAMS = NO from Doxyfile (obsolete option in newer doxygen versions; causes a warning and silently overrides CLASS_GRAPH) Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR hardens the GitHub Pages documentation build by ensuring Doxygen’s XML output directory exists on fresh CI checkouts and by removing an obsolete Doxygen configuration option that triggers warnings.
Changes:
- Pre-create
docs/_doxygen/xmlin the Pages workflow before running Doxygen. - Remove
CLASS_DIAGRAMS = NOfromdocs/Doxyfile(obsolete option; warning source).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
docs/Doxyfile |
Removes obsolete CLASS_DIAGRAMS setting; XML output remains configured to _doxygen/xml. |
.github/workflows/pages.yml |
Creates _doxygen/xml before running Doxygen to avoid missing-directory failures in CI. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Mock networkx in autodoc_mock_imports - Remove python/bindings from Doxygen INPUT (duplicate init_graph warnings) - Replace unicode ellipsis with ASCII in column-generation.md code block Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- Add numpy to autodoc_mock_imports (pricing_pool.py imports it at module level) - Remove cpp/api from exclude_patterns so Exhale-generated API pages are built - Create docs/installation.md (referenced in index.md toctree); add gitignore exception to unblock INSTALL* pattern match on case-insensitive filesystems - Fix class name NGPathExtensionFunction -> NgPathExtensionFunction - Remove BucketAlgorithmParams doxygenclass (Python-only wrapper, not C++ class) - Use doxygenconcept for ResourceTypeConcept instead of doxygenclass Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Breathe/Exhale emit duplicate C++ declaration warnings when the same class is documented in both a curated page (beginner_api, advanced_api) and the Exhale-generated full-tree page. This is a known Breathe limitation with no upstream fix; dropping -W lets the build succeed and produce correct HTML — cross-references still resolve to the curated pages. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Contributor
Author
|
/run-ci |
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.
Summary
Test plan