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

Publish docs on push #48

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Publish docs on push #48

wants to merge 1 commit into from

Conversation

Nycto
Copy link
Collaborator

@Nycto Nycto commented Jan 21, 2024

This change adds a github workflow that auto-generates docs and publishes to a github page for every push to mainline. This is a pre-emptive pull request based on the conversation in #47. If if there is no interest in this, that's totally fine 👍

Getting this to work requires some administrative overhead to setup the correct branches and github tokens, as documented here: https://github.com/peaceiris/actions-gh-pages#github-pages-action

You can see an example of the generated outcome from another project, which uses a similar setup: https://necsusecs.github.io/Necsus/

@Nycto Nycto mentioned this pull request Jan 21, 2024
@samdze
Copy link
Owner

samdze commented Jan 23, 2024

This would be very useful!
Nim generated documentation HTMLs are not that great in my opinion but there sure is value in them for those that want to explore the API a bit

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