Add documentation based on Sphinx#122
Merged
Wenzel merged 26 commits intoIntelLabs:masterfrom Nov 16, 2022
Merged
Conversation
il-steffen
approved these changes
Nov 16, 2022
Collaborator
|
I would do less minimal README. Keep disclaimer, main features + 1 paragraph on getting started. The full installation guide can cover further topics like typical problems/fixes, remote install, docker, other ansible usage. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This PR adds a new documentation system based on Sphinx
Available in
docs/The docs will be hosted on the Github Pages at https://IntelLabs.github.io/kAFL/ (once this PR is merged and the Pages have been configured)