Skip to content
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

Feature request: improve documentation navigation (and css?) #142

Closed
DocSunset opened this issue Jun 27, 2023 · 0 comments
Closed

Feature request: improve documentation navigation (and css?) #142

DocSunset opened this issue Jun 27, 2023 · 0 comments

Comments

@DocSunset
Copy link

There are no breadcrumbs, no side panel/tree view, no top navigation bar, etc.; the complete lack of page-wide cross-document navigation makes it very frustrating to move between pages (particularly the high-level API docs and low-level API docs which seem to contain most of the relevant documentation). I can bring the usual top bar back by changing DISABLE_INDEX in reference.doxygen to NO, and the side panel can be reinstated by setting GENERATE_TREEVIEW = YES. Then I see that doxygen "helpfully" generates a bunch of other documentation pages that I'm guessing are the reason why these navigation features were suppressed in the first place? I suppose that it was decided that giving access to the automatically generated data structures and files documentation subtrees would muddy the documentary waters, and so the navigation was turned off? If that's the case, perhaps some modification could be made to the default header HTML to add navigation links between the main documentation pages?

For what it's worth (~ $0.02) I would also appreciate if the documentation was nicer to look at. I have recently used this plugin on my project and it seems pretty nice overall, but I have only had it running for a couple days so I can't 100% endorse it so soon. I can say, at least, that it's easy to set up and looks good so far.

radarsat1 added a commit that referenced this issue Feb 16, 2024
radarsat1 added a commit that referenced this issue Feb 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant