Publish crate docs to GitHub Pages #86
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hi @dekobon, can you help us with enabling Github pages for |
We already chatted about that; pages are disabled on the org level and syseng team is not interested in changing that. |
xeioex
approved these changes
Oct 24, 2024
There was a problem hiding this comment.
Documentation for ngx::log looks to empty. Can we re-export the macros like ngx_log_debug in the src/log.rs so they appear in the docs for ngx::log too?
Otherwise looks good.
bavshin-f5
force-pushed
the
github-pages
branch
from
def7626 to
e125faf
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docs.rs builds are currently broken (#85), and getting these fixed seems a bit complicated. The next best thing is to host the crate documentation ourselves on GitHub Pages.
Preview: https://bavshin-f5.github.io/ngx-rust/ngx/index.html
Only nightly docs for now, will figure out how to handle the tagged releases later.
Required repository configuration:
Github Actionsmaster(should be created and configured automatically on the first run).