Add docs generation script. #47
Merged
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
Motivation: Documentation is a real help when using a project, we should be generating it. Modifications: - Ported docs script from SwiftNIO. Result: We can provide API documentation.
Lukasa
force-pushed
the
cb-add-docs-script
branch
from
75adebb
to
b453309
Compare
Merged
tomerd
reviewed
Nov 20, 2020
docker/Dockerfile
Outdated
| @@ -26,7 +26,7 @@ RUN mkdir -p $HOME/.tools | |||
| RUN echo 'export PATH="$HOME/.tools:$PATH"' >> $HOME/.profile | |||
|
|
|||
| # script to allow mapping framepointers on linux (until part of the toolchain) | |||
| RUN wget -q https://raw.githubusercontent.com/apple/swift/master/utils/symbolicate-linux-fatal -O $HOME/.tools/symbolicate-linux-fatal | |||
| RUN wget -q https://raw.githubusercontent.com/apple/swift/main/utils/symbolicate-linux-fatal -O $HOME/.tools/symbolicate-linux-fatal | |||
| RUN chmod 755 $HOME/.tools/symbolicate-linux-fatal | |||
There was a problem hiding this comment.
we can probably just get rid of this all-together, we do not need it
tomerd
reviewed
Nov 20, 2020
| my_path="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" | ||
| root_path="$my_path/.." | ||
| version=$(git describe --abbrev=0 --tags || echo "0.0.0") | ||
| modules=( NIOSSH ) |
There was a problem hiding this comment.
I see there are a f ew other modules in the repo, is including only NIOSSH in the docs intentional?
There was a problem hiding this comment.
Yes, the other modules are binaries.
tomerd
approved these changes
Nov 20, 2020
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:
Documentation is a real help when using a project, we should be
generating it.
Modifications:
Result:
We can provide API documentation.