-
Notifications
You must be signed in to change notification settings - Fork 32
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Refactor generated C++ documentation: Iterator/Future #589
Comments
This is what it looks like after manually fixing the headings, as suggested above. The resulting files are attached as an example: Archive.zip |
sync-by-unito
bot
changed the title
C++ API reference documentation for answers
Refactor generated C++ documentation: Iterator/Future
Feb 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Description
The answer section of the C++ driver API reference contains four new files:
Adding these files to the C++ Driver API reference makes in-page navigation much harder.
The first three files add third-level headings, visible in the in-page table of contents, with very long and strangely looking names, like
Future< RETURN, NATIVE_PROMISE, HELPER >
.The fourth file adds about 30 different 3rd-level headings to the page, making the table of contents very long and barely usable (it fails to scroll for some reason).
Environment
Reproducible Steps
Generate the API reference for the C++ driver
Insert the API reference into our documentation
Build the docs and check the resulting API reference page
Expected result
Shorter 3rd level headings in the first three files, like
Future
.One 3rd level heading combining all other headings from the
typedefs.adoc
file.Additional information
Our Table of contents displays all 2nd and 3rd level headings on the page.
The text was updated successfully, but these errors were encountered: