Enable building docs in the CI pipeline #384
Merged
Conversation
This file contains hidden or 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
apoelstra
previously approved these changes
May 3, 2022
Member
|
Would need rebase again |
The compiler emits various warnings of type: warning: public documentation for ... Remove the docs that include links to private methods and types.
Fix all the docs build warnings for broken links.
Add docs build to the ci script, guard with env var `DO_DOCS` as we do in other crates in the stack. Add a docs build job to the CI configuration using the nightly toolchain as required.
apoelstra
approved these changes
May 10, 2022
heap-coder
added a commit
to heap-coder/rust-miniscript
that referenced
this pull request
Sep 27, 2025
…I pipeline
c40d350dde582ae84bc155c17a1aed37fe37722e CI: Build the docs (Tobin C. Harding)
3ff4f14c8108b94fa448ac0b04615f1893ab2238 Fix docs links (Tobin C. Harding)
432c49bb7ba422b26618d531ac79fcffc52f58d4 Remove reference to private types (Tobin C. Harding)
Pull request description:
First fix all the docs build errors then enable docs build in CI, as we do in other crates in our stack.
ACKs for top commit:
apoelstra:
ACK c40d350dde582ae84bc155c17a1aed37fe37722e
sanket1729:
re-ACK c40d350dde582ae84bc155c17a1aed37fe37722e
Tree-SHA512: d5370db7db6a3f2fa7cfbacc8fa4c55073c42c353fb763c19d0f42a3abfe7362ffb9eb97b3fa20399481a2cbe45e2962c092249be06197b37f5839db55deaa5b
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
First fix all the docs build errors then enable docs build in CI, as we do in other crates in our stack.