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.

Sign up for GitHub

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

Uniform treatment of sidebar #1251

Open
wants to merge 59 commits into
base: master
Choose a base branch
from
Open

Uniform treatment of sidebar #1251

wants to merge 59 commits into from
+2,376 −1,367

Commits on Dec 6, 2024

  1. WIP

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    5acab30 View commit details
    Browse the repository at this point in the history

  2. WIP 2

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    a3e3aad View commit details
    Browse the repository at this point in the history

  3. small improvements

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    0f9ae22 View commit details
    Browse the repository at this point in the history

  4. Rename file

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    99abfa2 View commit details
    Browse the repository at this point in the history

  5. Create a separate module for intermediate index

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    6f5cd16 View commit details
    Browse the repository at this point in the history

  6. Allow to order modules

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    d743543 View commit details
    Browse the repository at this point in the history

  7. Sidebar: Use a better name when no zero title are there

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    4f0b909 View commit details
    Browse the repository at this point in the history

  8. Remove resolver logic to return all pages

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    416b465 View commit details
    Browse the repository at this point in the history

  9. Keep --root groups

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    7f23b64 View commit details
    Browse the repository at this point in the history

  10. Use computed index to compute json

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    7294fc4 View commit details
    Browse the repository at this point in the history

  11. Fix adding container pages in indexes

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    db9afcb View commit details
    Browse the repository at this point in the history

  12. Index: handle roots even when they are included in each others

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    0a0f1d7 View commit details
    Browse the repository at this point in the history

  13. Sidebar: rendering improvements

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    b5075a6 View commit details
    Browse the repository at this point in the history

  14. Driver: Use a sidebar root for pages, and one per library

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    b42e114 View commit details
    Browse the repository at this point in the history

  15. Add a @toc_status tag 

    Which when is `opened`, makes the entry always opened when visible
    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    1bafc35 View commit details
    Browse the repository at this point in the history

  16. Index: Comments on --root

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    3cc15c1 View commit details
    Browse the repository at this point in the history

  17. promote tests

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    59290d0 View commit details
    Browse the repository at this point in the history

  18. Remove the link from content

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    70030f5 View commit details
    Browse the repository at this point in the history

  19. Index: Ignore items enclosed in stop comments

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    46b0e32 View commit details
    Browse the repository at this point in the history

  20. Revert "Driver: Use a sidebar root for pages, and one per library" 

    This reverts commit 448e155.
    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    c8a267f View commit details
    Browse the repository at this point in the history

  21. Index: Add implementations to the index

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    f090f82 View commit details
    Browse the repository at this point in the history

  22. promote test to fixup

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    67210a0 View commit details
    Browse the repository at this point in the history

  23. Sidebar: Actually add implementations to the sidebar

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    71278bf View commit details
    Browse the repository at this point in the history

  24. Driver: Add a src/ landing page

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    8c33344 View commit details
    Browse the repository at this point in the history

  25. Compatibility

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    068a856 View commit details
    Browse the repository at this point in the history

  26. CSS: slightly restyle the global sidebar

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    e99b74c View commit details
    Browse the repository at this point in the history

  27. Compatibility

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    41d7509 View commit details
    Browse the repository at this point in the history

  28. Sidebar: Add the global sidebar to implementation pages

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    3c8ddaf View commit details
    Browse the repository at this point in the history

  29. Driver: remove LICENSE and other file in non voodoo mode

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    447be65 View commit details
    Browse the repository at this point in the history

  30. Sidebar: Use short title if present

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    9aa24dc View commit details
    Browse the repository at this point in the history

  31. Breadcrumbs: use sidebar index if possible

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    bf57d95 View commit details
    Browse the repository at this point in the history

  32. Breadcrumbs: keep original behavior when no sidebar is given

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    f066756 View commit details
    Browse the repository at this point in the history

  33. Breacrumbs: simplify logic 

    Before, it was complicated:
- A page with no "parent" breadcrumbs would not get it's "current" breadcrumb
displayed,
- Except if it's a leaf page with name index.

Now, all pages have breadcrumbs
    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    9f32283 View commit details
    Browse the repository at this point in the history

  34. Sidebar: sort by kind first

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    4de674b View commit details
    Browse the repository at this point in the history

  35. Sidebar: better default order

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    bade68d View commit details
    Browse the repository at this point in the history

  36. Driver: don't include source dir if no implementation are rendered

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    6f4a550 View commit details
    Browse the repository at this point in the history

  37. Compatibility

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    871fbef View commit details
    Browse the repository at this point in the history

  38. Json index: use json printing function

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    a4382f7 View commit details
    Browse the repository at this point in the history

  39. Delete useless Html.Utils module

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    7277424 View commit details
    Browse the repository at this point in the history

  40. Format dune files

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    29c81de View commit details
    Browse the repository at this point in the history

  41. Breadcrumbs: fix order

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    6e823d0 View commit details
    Browse the repository at this point in the history

  42. Sidebar: Add a hidden value for toc_status.

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    b329862 View commit details
    Browse the repository at this point in the history

  43. Sidebar: Add order_category to help ordering the unordered pages

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    42d3e37 View commit details
    Browse the repository at this point in the history

  44. Promote tests

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    03acc3b View commit details
    Browse the repository at this point in the history

  45. Add a --escape-breadcrumbs option to add a 🏠 to breadcrumbs 

    This allows to go past breadcrumbs limit eg to the list of packages
    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    604872f View commit details
    Browse the repository at this point in the history

  46. Fix breadcrumbs with leaf index pages

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    056e9d9 View commit details
    Browse the repository at this point in the history

  47. Doc compute landing pages for not selected packages

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    0d38470 View commit details
    Browse the repository at this point in the history

  48. Driver: better landing pages

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    cad19c5 View commit details
    Browse the repository at this point in the history

  49. compatibility

    @panglesd
    panglesd committed Dec 6, 2024
    Configuration menu
    Copy the full SHA
    63f50e8 View commit details
    Browse the repository at this point in the history

Commits on Dec 9, 2024

  1. Add a 'Home' link to breadcrumbs when no sidebar is given

    @panglesd
    panglesd committed Dec 9, 2024
    Configuration menu
    Copy the full SHA
    6825e3c View commit details
    Browse the repository at this point in the history

  2. Fix default order of children

    @panglesd
    panglesd committed Dec 9, 2024
    Configuration menu
    Copy the full SHA
    6779665 View commit details
    Browse the repository at this point in the history

  3. Changelog entry for ocaml#1251

    @panglesd
    panglesd committed Dec 9, 2024
    Configuration menu
    Copy the full SHA
    a4b69c2 View commit details
    Browse the repository at this point in the history

  4. Doc: page tags 

    Document `@children_order`, `@order_category` and `@toc_status`.
    @panglesd
    panglesd committed Dec 9, 2024
    Configuration menu
    Copy the full SHA
    5103c6b View commit details
    Browse the repository at this point in the history

  5. Doc: update canonical roots to the doclibless hierarchy

    @panglesd
    panglesd committed Dec 9, 2024
    Configuration menu
    Copy the full SHA
    ccf3f01 View commit details
    Browse the repository at this point in the history

  6. Index: add support for extension constructors

    @panglesd
    panglesd committed Dec 9, 2024
    Configuration menu
    Copy the full SHA
    3b53164 View commit details
    Browse the repository at this point in the history

  7. Remove now unused handle_file function 

    This function was used by sherlodoc, it is not anymore.
    @panglesd
    panglesd committed Dec 9, 2024
    Configuration menu
    Copy the full SHA
    9cf80ab View commit details
    Browse the repository at this point in the history

Commits on Dec 10, 2024

  1. Doc: explicitly make @order_category a driver-only tag

    @panglesd
    panglesd committed Dec 10, 2024
    Configuration menu
    Copy the full SHA
    5a15d21 View commit details
    Browse the repository at this point in the history

Commits on Dec 11, 2024

  1. Breadcrumbs: factor home breadcrumb

    @panglesd
    panglesd committed Dec 11, 2024
    Configuration menu
    Copy the full SHA
    4a6d2bd View commit details
    Browse the repository at this point in the history

  2. Breadcrumb: rename escape-breadcrumb to home-breadcrumb

    @panglesd
    panglesd committed Dec 11, 2024
    Configuration menu
    Copy the full SHA
    dea50a4 View commit details
    Browse the repository at this point in the history