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

Improve performances of sidebar generation and loading #544

Open
tristanlatr opened this issue Apr 7, 2022 · 0 comments
Open

Improve performances of sidebar generation and loading #544

tristanlatr opened this issue Apr 7, 2022 · 0 comments

Comments

@tristanlatr
Copy link
Contributor

With the side bar generation, especially on project that contain lots of classes per modules and with a value higher than 1 for option --sidebar-expand-depth, files can rapidly take a few megas and be really long to load, even locally. To ensure the best user experience no matter the value of --sidebar-expand-depth, we should generate the sidebars for each documentable in a separate file (i.e. .sidebar.html) and load it with JS when the rest of the content has been loaded.

Links:

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