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

Remove support for examples from judoc #2747

Merged
merged 1 commit into from
Apr 22, 2024

Conversation

paulcadman
Copy link
Collaborator

@paulcadman paulcadman commented Apr 19, 2024

The judoc examples feature is currently unused. This feature was added in #1442

Keeping support for this feature adds a cost to HTML generation. We are removing this to improve the performance of juvix html.

To just render the HTML documentation we only require the scoper result from the pipeline. To support the examples we need the type checking result. The cost is significant in larger projects as the pipeline is run for each import.

Part of #2744

@paulcadman paulcadman added judoc Juvix documentation generation backend:html labels Apr 19, 2024
@paulcadman paulcadman added this to the 0.6.2 milestone Apr 19, 2024
@paulcadman paulcadman self-assigned this Apr 19, 2024
The judoc examples feature is currently unused.

Keeping support for this feature adds a cost to HTML generation. We are
removing this to improve the performance of `juvix html`.

To just render the HTML documentation we only require the scoper result from
the pipeline. To support the examples we need the type checking result.
The cost is significant in larger projects as the pipeline is run for
each import.
@paulcadman paulcadman force-pushed the remove-judoc-examples-support branch from 10a0a5c to 0c863e3 Compare April 19, 2024 16:24
@paulcadman paulcadman requested a review from janmasrovira April 19, 2024 16:29
@paulcadman paulcadman merged commit 0e8ccb7 into main Apr 22, 2024
4 checks passed
@paulcadman paulcadman deleted the remove-judoc-examples-support branch April 22, 2024 09:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend:html judoc Juvix documentation generation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants