Skip to content

Commit 91a9351

Browse files
andreas-zellerandreas-zeller
authored
Merge pull request #186 from uds-se/jupyter-book
Jupyter book support
2 parents 3a79f27 + 38bdfc4 commit 91a9351

File tree

11 files changed

+164
-1
lines changed

11 files changed

+164
-1
lines changed

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,9 @@ notebooks/BugBoard.ipynb
116116
notebooks/Todos.ipynb
117117
notebooks/SimpleGrammarMiner.ipynb
118118

119+
# Jupyter Book
120+
_build/**
121+
119122
# PyCharm settings
120123
.idea/
121124

‎_config.yml‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
title: The Fuzzing Book
2+
author: Andreas Zeller, Rahul Gopinath, Marcel Böhme, Gordon Fraser, and Christian Holler
3+
copyright: 2021-2025 CISPA Helmholtz Center for Information Security (www.cispa.de); © Copyright 2018-2020 Saarland University, authors, and contributors. All Rights Reserved
4+
logo: "_static/fuzzingbook.png"
5+
6+
bibtex_bibfiles:
7+
- fuzzingbook.bib
8+
9+
latex:
10+
latex_documents:
11+
targetname: fuzzingbook.tex
12+
13+
sphinx:
14+
config:
15+
latex_engine: xelatex
16+
latex_show_pagerefs: true
17+
latex_show_urls: footnote
18+
19+
execute:
20+
execute_notebooks: 'off'
21+
stderr_output: show
22+
timeout: 300
23+
24+
parse:
25+
myst_enable_extensions:
26+
# - amsmath
27+
- colon_fence
28+
- dollarmath
29+
# - html_admonition
30+
# - html_image
31+
- linkify
32+
- replacements
33+
- smartquotes
34+
- substitution
35+
- tasklist
36+
- deflist
37+
38+
html:
39+
announcement: '<p>This is a beta version of fuzzingbook.org, currently in development. See the <a href="https://fuzzingbook.org/" style="color:white!important;">classic site</a> for resources.</p>'
40+
use_issues_button: true
41+
use_repository_button: true
42+
43+
repository:
44+
url: "https://github.com/uds-se/fuzzingbook/"
45+
path_to_book: "docs/notebooks"
46+
branch: master
47+
48+
launch_buttons:
49+
binderhub_url: "https://mybinder.org"
50+
thebe: false # Does not support local imports

‎_static/custom.css‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
/*
2+
CSS stylesheet for fuzzingbook
3+
4+
This is used for the JB HTML version.
5+
*/
6+
7+
/* Loading fonts in Jupyter */
8+
@import url(https://fonts.googleapis.com/css?family=Fira+Mono:400,500,700|Patua+One|Open+Sans|Source+Code+Pro);
9+
10+
11+
/* Fonts */
12+
h1, h2, h3, h4, h5 {
13+
font-family: 'Patua One', Helvetica, Arial, sans-serif;
14+
}
15+
16+
body {
17+
font-family: 'Open Sans', sans-serif;
18+
}
19+
20+
code, kbd, pre, samp {
21+
font-family: 'Fira Mono', 'Source Code Pro', monospace;
22+
}
23+
24+
.CodeMirror pre {
25+
font-family: 'Fira Mono', 'Source Code Pro', monospace;
26+
}
27+
28+
29+
/* Headers are dark red, too */
30+
/* should be #B03A2E, but must work in dark & light mode */
31+
/* Alas, the [data-theme="light"] selector has no effect: https://pydata-sphinx-theme.readthedocs.io/en/v0.9.0/user_guide/customizing.html*/
32+
33+
h1, h2, h3 {
34+
color: #cb4334!important;
35+
}
36+
37+
/* And links also come in shades of red */
38+
a, button {
39+
color: #cb4334!important;
40+
}
41+
42+
43+
svg a {
44+
text-decoration: none!important;
45+
}

‎_static/fuzzingbook.png‎

25.6 KB
Loading

‎_static/mastodon-timeline.css‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../html/mastodon-timeline.css

‎_toc.yml‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
format: jb-book
2+
root: index
3+
parts:
4+
- caption: Introduction
5+
chapters:
6+
- file: Tours
7+
- file: Intro_Testing
8+
- caption: Lexical Fuzzing
9+
chapters:
10+
- file: Fuzzer
11+
- file: Coverage
12+
- file: MutationFuzzer
13+
- file: GreyboxFuzzer
14+
- file: SearchBasedFuzzer
15+
- file: MutationAnalysis
16+
- caption: Syntactical Fuzzing
17+
chapters:
18+
- file: Grammars
19+
- file: GrammarFuzzer
20+
- file: GrammarCoverageFuzzer
21+
- file: Parser
22+
- file: ProbabilisticGrammarFuzzer
23+
- file: GeneratorGrammarFuzzer
24+
- file: GreyboxGrammarFuzzer
25+
- file: Reducer
26+
- caption: Semantical Fuzzing
27+
chapters:
28+
- file: FuzzingWithConstraints
29+
- file: GrammarMiner
30+
- file: InformationFlow
31+
- file: ConcolicFuzzer
32+
- file: SymbolicFuzzer
33+
- file: DynamicInvariants
34+
- caption: Domain-Specific Fuzzing
35+
chapters:
36+
- file: ConfigurationFuzzer
37+
- file: APIFuzzer
38+
- file: Carver
39+
- file: PythonFuzzer
40+
- file: WebFuzzer
41+
- file: GUIFuzzer
42+
- caption: Managing Fuzzing
43+
chapters:
44+
- file: FuzzingInTheLarge
45+
- file: WhenToStopFuzzing
46+
- caption: Appendices
47+
chapters:
48+
- file: AcademicPrototyping
49+
- file: PrototypingWithPython
50+
- file: ExpectError
51+
- file: Timer
52+
- file: Timeout
53+
- file: ClassDiagram
54+
- file: RailroadDiagrams
55+
- file: ControlFlow
56+
- caption: About This Book
57+
chapters:
58+
- file: ReleaseNotes
59+
- file: Importing
60+
- file: Guide_for_Authors

‎full_notebooks/_build‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_build

‎full_notebooks/_config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_config.yml

‎full_notebooks/_static‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_static

‎full_notebooks/_toc.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
../_toc.yml

0 commit comments

Comments
 (0)