search

siefkenj / unified-latex

Utilities for parsing and manipulating LaTeX ASTs with the Unified.js framework
MIT License
85 stars 20 forks source link

generate documentation and publish to github pages #75

Closed retorquere closed 6 months ago

siefkenj commented 6 months ago

This looks exciting :-). Can you explain a bit more about this PR? Also, is there a way to save an artifact from the other build processes, so unified-latex doesn't need to be built twice?

retorquere commented 6 months ago

The PR runs typedoc over the packages and produces a docs directory that's ready to be published to github docs; the included action then publishes the contents of the docs directory. The generated docs are taken from doc comments - pretty sparse, but easier to use than browsing through the sources trying to understand how to piece together how to use the library (especially the search is helpful).

I suppose it is possible to use artifacts but I'm not sure what artifacts are generated during the ws build that typedoc needs. But if you want to prevent a separate build to start, you could just add the steps from this action to an existing action.

retorquere commented 6 months ago

But I only see an existing action that runs on pull requests?

retorquere commented 6 months ago

This looks exciting :-). Can you explain a bit more about this PR? Also, is there a way to save an artifact from the other build processes, so unified-latex doesn't need to be built twice?

artifacts can be shared between jobs within an action, but AFAIK not outside a single action. Maybe that answers your question?