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

Sort modules in the stdlib api index in alphabetical order #1631

Merged
merged 1 commit into from
Jan 6, 2023

Conversation

Octachron
Copy link
Member

This PR patches the index files for the 4.13 to 5.0 API documentation to sort each link first by category:

  • text tutorials
  • stdlib and otherlibs modules
  • internal stdlib modules

and then alphabetically inside each category.

cc @gasche

Patch the index files for the 4.13 to 5.0 API documentation to sort
each link first by category:

- text tutorials
- stdlib and otherlibs modules
- internal stdlib modules

and then alphabetically inside each category.
@sanette
Copy link
Contributor

sanette commented Jan 4, 2023

this should solve
#1617
ocaml/ocaml#11478

however do I understand correctly that this has to be done manually at each new release? Couldn't this be integrated in the webman generation?

@Octachron
Copy link
Member Author

Those are the index pages generated by ocamldoc after tweaking the input send to ocamldoc. There is no special manual process required fortunately.

@sanette
Copy link
Contributor

sanette commented Jan 4, 2023

oh great, thanks. out of curiosity, where is the "tweaking" done?

@Octachron
Copy link
Member Author

ocaml/ocaml#11860

@tmattio
Copy link
Contributor

tmattio commented Jan 6, 2023

Thanks @Octachron!

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

Successfully merging this pull request may close these issues.

3 participants