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 documentation and publish to github pages #75

Merged
merged 1 commit into from
Feb 15, 2024

Conversation

retorquere
Copy link
Contributor

No description provided.

@siefkenj
Copy link
Owner

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
Copy link
Contributor Author

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
Copy link
Contributor Author

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

@retorquere
Copy link
Contributor Author

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?

@siefkenj siefkenj merged commit eecf85f into siefkenj:main Feb 15, 2024
1 check passed
@retorquere retorquere deleted the docs branch February 15, 2024 22:06
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