feat: enhance and fix documentation #1310
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
|
BTW, it's quite confusing that |
barendgehrels
force-pushed
the
feat/fix-and-enhance-documentation
branch
from
adb1509
to
694d6de
Compare
barendgehrels
commented
Sep 24, 2024
|
|
||
| echo "=== Resulting contents of generated 'adapted.html', there should be sections" | ||
| cat html/geometry/reference/adapted.html | grep section | ||
|
|
There was a problem hiding this comment.
@Lastique also for your information ('ll refer to it from elsewhere)
barendgehrels
force-pushed
the
feat/fix-and-enhance-documentation
branch
from
694d6de
to
23c1455
Compare
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 registration macros were not clear enough. They were not yet stating that
longitudeshould come first, and thenlatitude.Adding that, I encountered that the documentation procedure was broken on my Mac. This was caused in the end by this
commit: boostorg/boostbook@116c7b0 - so I wonder why it can run in the main branches. See also boostorg/boostbook#17
Anyway, after fixing that locally I can generate the same documentation again. There were quite some warnings (by doxygen, or doxygen to qbk) which are fixed. Also some other unclarities are enhanced.
Some pages were not used for already 10 years and are removed. This was in doxygen - but we use quickbook now.
Documentation looks now like (some shots):