Fix documentation with recent versions of doxygen #6384
Merged
Conversation
This file contains 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
Doxygen layout files are dependent upon doxygen version. There was a breaking change in 1.9.8 to support c++ modules. Doxygen groups had been labeled as modules, but are now labeled as topics. - Renamed layout.xml to DoxygenLayout_1_8_10.xml - Added DoxygenLayout_1_9_8.xml - Add switch between the two based on the version of doxygen
This file causes the sidebar to disappear for Doxygen versions 1.10.0 and higher. This file apparently only made cosmetic changes to the documentation, so we will try not using it, rather than spend the time trying to fix it.
nilsvu
approved these changes
Nov 23, 2024
wthrowe
approved these changes
Nov 26, 2024
There was a problem hiding this comment.
Seems to work with doxygen 1.12.0. I get a bunch of nonsensical warnings, but that's not a blocker. Example:
/home/wthrowe/tmp/host-docs/source/src/Evolution/Executables/Cce/KleinGordonCharacteristicExtract.hpp:125: warning: no uniquely matching class member found for
typedef EvolutionMetavars::factory_creation::tmpl::map< tmpl::pair< LtsTimeStepper, TimeSteppers::lts_time_steppers >, tmpl::pair< StepChooser< StepChooserUse::LtsStep >, cce_step_choosers >, tmpl::pair< StepChooser< StepChooserUse::Slab >, StepChoosers::standard_slab_choosers< system, local_time_stepping, false > >, tmpl::pair< TimeSequence< double >, TimeSequences::all_time_sequences< double > >, tmpl::pair< TimeSequence< std::uint64_t >, TimeSequences::all_time_sequences< std::uint64_t > >, tmpl::pair< Event, tmpl::list< Cce::Events::ObserveFields, Cce::Events::ObserveTimeStep > >, tmpl::pair< Trigger, tmpl::append< Triggers::logical_triggers, Triggers::time_triggers > > > factory_classes
Possible candidates:
'T std::map::map(T... args)' at line 32548 of file /home/wthrowe/tmp/host-docs/source/docs/config/cppreference-doxygen-web.tag.xml
'T std::pmr::map::map(T... args)' at line 37437 of file /home/wthrowe/tmp/host-docs/source/docs/config/cppreference-doxygen-web.tag.xml
|
Works on CI |
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.
Proposed changes
Fix #5490
The first commit just updates the versions of files we use from the Doxygen Awesome CSS theme
Upgrade instructions
Code review checklist
make docto generate the documentation locally intoBUILD_DIR/docs/html.Then open
index.html.code review guide.
bugfixornew featureif appropriate.Further comments