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

website: add "API Reference" generation #406

Merged
merged 15 commits into from
Dec 9, 2024

Conversation

naskio
Copy link
Member

@naskio naskio commented Dec 6, 2024

Summary

This PR introduces an API Reference section to the website, generated using DocFX.
The section is conditionally injected into the site if it exists. The CI/CD pipeline has been updated to automatically build it when code changes are detected.

Preview

Key Changes

  1. DocFX Integration:

    • Added DocFX tool and configuration (docfx.json).
    • JavaScript script for transforming and fixing the generated folder.
  2. Website Updates:

    • Injects API Reference documentation conditionally only when it has been generated.
    • Add some yarn commands to support the generation process.
  3. CI/CD Enhancements:

    • Configured pipeline to generate and publish the "API Reference" when code changes.
  4. Miscellaneous:

    • Updated yarn.lock to remove warnings.

naskio added 12 commits December 6, 2024 11:18
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
…y DocFX

Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
@naskio naskio marked this pull request as ready for review December 6, 2024 11:26
@naskio naskio changed the title add "API reference" generation website: add "API Reference" section generation Dec 6, 2024
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
Signed-off-by: Mehdi Nassim KHODJA <18899702+naskio@users.noreply.github.com>
@naskio naskio changed the title website: add "API Reference" section generation website: add "API Reference" generation Dec 7, 2024
@marcin-krystianc marcin-krystianc requested review from dgl and removed request for dgl December 9, 2024 10:52
@marcin-krystianc marcin-krystianc merged commit 56ee621 into G-Research:master Dec 9, 2024
244 checks passed
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.

2 participants