Docs: Add a descriptive Main Page to the Doxygen site. #4466
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
Add a new doxygen_index.md file, and use the Doxygen setting USE_MDFILE_AS_MAINPAGE to include it as the contents of the Main Page. Fixes OSGeo#3689.
|
thanks! |
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.
Add a new doxygen_index.md file, and use the Doxygen setting
USE_MDFILE_AS_MAINPAGE to include it as the contents of the Main Page.
Fixes #3689.
What does this PR do?
Adds some descriptive content to the "Main Page" of the raw Doxygen output at https://gdal.org/doxygen/index.html so it's not just mysteriously blank.
I've copied the intro paragraph about GDAL from the main website verbatim, and added some words of my own about the Doxygen site and how to use it.
What are related issues/pull requests?
Issue raised in #3689
Tasklist
Environment
Provide environment details, if relevant: