Refactor Doxygen INPUT organization for better documentation flow with appendices at end#9
Closed
Refactor Doxygen INPUT organization for better documentation flow with appendices at end#9
Conversation
Co-authored-by: WardF <4324946+WardF@users.noreply.github.com>
Co-authored-by: WardF <4324946+WardF@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Documentation needs to be refactored.
Refactor Doxygen INPUT organization for better documentation flow
Aug 12, 2025
Owner
|
@copilot The Appendices should all appear at the end, in order. |
Co-authored-by: WardF <4324946+WardF@users.noreply.github.com>
Author
Fixed in commit 04ca73a. Moved all files containing appendices to the end of the INPUT list in this order:
All appendices now appear at the end in logical order. |
Copilot
AI
changed the title
Refactor Doxygen INPUT organization for better documentation flow
Refactor Doxygen INPUT organization for better documentation flow with appendices at end
Aug 12, 2025
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.
The NetCDF-C documentation was poorly organized due to Doxygen's "first-in, first-out" processing behavior, where files listed in the
INPUTsection appear in the generated documentation in the same order they are specified. This resulted in users seeing advanced internal documentation before basic installation guides, API reference mixed arbitrarily with tutorials, and appendices scattered throughout instead of appearing at the end.Changes Made
Reorganized the
INPUTsection indocs/Doxyfile.into follow a logical progression that guides users from basic concepts to advanced topics, with all appendices properly positioned at the end:mainpage.dox,groups.dox)building-with-cmake.md,install-fortran.md, etc.)tutorial.dox,FAQ.md)netcdf.h,netcdf_mem.h, etc.)inmemory.md,quantize.md,byterange.md,auth.md, etc.)internal.md,inmeminternal.dox, etc.)cloud.md(Appendices A, B, C for S3 support)dispatch.md(Appendices A, B for dispatch layer)filters.md(Appendices A-I for filter mechanisms)nczarr.md(Appendices A-E for Zarr format)pluginpath.md(Appendix E.1 for plugin paths)Impact
This reorganization addresses core usability issues where users would encounter:
Now users follow a natural learning path: What is NetCDF? → How do I build it? → How do I use it? → Advanced features → Reference materials → Appendices.
Validation
This minimal change to a single configuration file significantly improves the organization and usability of the entire NetCDF-C documentation system.
Fixes #8.
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.