-
Notifications
You must be signed in to change notification settings - Fork 640
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
Some documentation pages are unexpectedly blank #2483
Comments
The page is empty because its a new section I guess, press the "Next" button on that mostly blank page (the right arrow) |
The settings for section chunking with HTML output are in
See also https://boostorg.github.io/quickbook/doc/html/boost_doc_tools/parameters.html Changing to Chunking (splitting to separate HTML pages) can be disabled locally:
Indeed including that leads to the first example appearing on the "more_examples.htm" page, while subsequent sections still appear on their own individual pages. I'd say we want to do this change: |
Yeah its not perfect.. |
We tried to fix that before. I don't even remember in what library. IIRC, the problem is we can't control the TOC depth for individual sections and the reference has subsections that look bad in the TOC. If that's the case, the best solution would be to adapt docca to generate a document hierarchy that looks betters in the TOC. |
I reckon it would be nice if we could include "local" TOCs on page currently empty-ish
…On Wed, Jul 13, 2022, at 10:01 PM, Alan de Freitas wrote:
We tried to fix that before. I don't even remember in what library.
IIRC, the problem is we can't control the TOC depth for individual sections and the reference has subsections that look bad in the TOC.
If that's the case, the best solution would be to adapt docca to generate a document hierarchy that looks betters in the TOC.
—
Reply to this email directly, view it on GitHub <#2483 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AACPEAIVVMX6E7ELY6EG7L3VT4OATANCNFSM53PBWVXQ>.
You are receiving this because you commented.Message ID: ***@***.***>
|
Yes, I think it would be good enough to have a local TOC with the subitems from the parent page and a link back to the parent page. As-is, if I copy the link from the main page and send it to a colleage, then the colleage could be lost because there's no information on the page linked and navigation by icons in the top right isn't clear (no text) and, when they opened the direct link, they can't just press the browser's back button to work from the parent page. So having the local TOC would help to navigate around the documentation. |
Version of Beast
it seems all versions
Steps necessary to reproduce the problem
Small documentation issue.
Main documentation page [master, 1.78.0, 1.68.0] -> see "HTTP Examples" or "More Examples" with subitems. Click it.
HTTP Examples documentation page [master, 1.78.0, 1.68.0] -> empty page. I would expect the subitems on the previous page to be listed here
I did a small amount of digging. It looks like HTTP Examples page is generated from this QBK? I see the text
These examples in this section are working functions that may be found in the examples directory. They demonstrate the usage of the library for a variety of scenarios.
is there and additional text describing each sub item. But I am not familiar with QBK to diagnose why the page is empty.It seems some other sections are similarly empty. The Concepts 1.78.0 page is similarly empty as is the 1.78.0 Configuration page. The 1.78.0 Quick Look page is empty -- but it at least links to the
example
directory listing even if it doesn't describe which examples do what.Other sections appear to be correctly filled out. For example, the 1.78.0 WebSockets section has content.
It looks like the WebSocket section QBK mentions only a single section (with notes, headings, tables, includes, etc) and links to other sections while the HTTP Examples QBK has multiple sections.
The text was updated successfully, but these errors were encountered: