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

Generate API documentation #1372

Merged
merged 16 commits into from
Mar 10, 2023
Merged

Generate API documentation #1372

merged 16 commits into from
Mar 10, 2023

Conversation

Jym77
Copy link
Contributor

@Jym77 Jym77 commented Mar 9, 2023

Closes #1371.

Since #290, we have ways to extract the API autombatically, but forgot to generate the actual documentation (there was a script, that was never called 🙈).
This add a documentation config, and instruction to generate it in release cycle.
Additionally, this cleans up a bit the scripts folder.

@Jym77 Jym77 self-assigned this Mar 9, 2023
@Jym77 Jym77 added internal Change that only affects internal APIs or other non-public aspects documentation Update to documentation only labels Mar 9, 2023
@Jym77
Copy link
Contributor Author

Jym77 commented Mar 9, 2023

!pr dedupe

@Jym77 Jym77 marked this pull request as ready for review March 10, 2023 10:54
@Jym77 Jym77 requested review from a team and rcj-siteimprove March 10, 2023 10:54
@Jym77 Jym77 added this pull request to the merge queue Mar 10, 2023
Merged via the queue into main with commit f40a67a Mar 10, 2023
@Jym77 Jym77 deleted the api-documentation branch March 10, 2023 15:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Update to documentation only internal Change that only affects internal APIs or other non-public aspects
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation is not generated
2 participants