feat(doc): Include extrernal libraries into forge doc scope #6290
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
mattsse
requested changes
Nov 12, 2023
crates/doc/src/builder.rs
Outdated
|
|
||
| if parser_result.is_err() { | ||
| if from_library { | ||
| // Ignore failures for library files |
crates/doc/src/builder.rs
Outdated
| eyre::eyre!( | ||
| let parser_result = solang_parser::parse(&source, i); | ||
|
|
||
| if parser_result.is_err() { |
There was a problem hiding this comment.
I'd like this as a match statement insted that assigns let (mut source_unit, comments) =
so we can get rid of the unwraps
mattsse
approved these changes
Nov 12, 2023
This was referenced Apr 26, 2024
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.
Motivation
Closes #5761 and adds ability to generate docs for external dependencies via
--include-librariesflagSolution
List of documents now always contains all
.solfiles found in lib directories. They are getting filtered out if--include-librariesis off when the mdbook is generated.ContractInheritancepreprocessor captures inherited contracts from external libraries only if--include-librariesis onGitSourcepreprocessor never generates git source links for contracts from external librariesInheritDocalways includes contracts from external libs when matching@inheritdocstatements