Skip to content

Add introduction of the web report to the docs #404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

Add introduction of the web report to the docs #404

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
877cbcc
Add Introduction of Web Report to the docs
zinwang Oct 20, 2022
25e3d1a
Build the document
zinwang Oct 20, 2022
c6af7d7
Update Report in the docs
zinwang Oct 21, 2022
3f6758e
Build the document
zinwang Oct 21, 2022
0be7069
Update Report in the docs
zinwang Oct 24, 2022
741ca84
Build the document
zinwang Oct 24, 2022
7b4da90
Build the document
zinwang Nov 3, 2022
196b23b
Keep up to date with master branch
zinwang Nov 3, 2022
5f2eee3
Rewrite the Web Report descriptions
zinwang Nov 3, 2022
145c1bc
Build the document
zinwang Nov 3, 2022
a16f469
Merge branch 'master' into intro_of_the_web_report_to_the_docs
zinwang Nov 7, 2022
f860deb
Update Web Report docs
zinwang Nov 8, 2022
c099d05
Rebuild the docs
zinwang Nov 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified docs/build/doctrees/environment.pickle
View file
Open in desktop
Binary file not shown.
Binary file modified docs/build/doctrees/index.doctree
View file
Open in desktop
Binary file not shown.
1 change: 1 addition & 0 deletions docs/build/html/_sources/index.rst.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ This guide will explain how to set up Quark, use it, and customize it.
:caption: Contents:

install_index
report
quark_script
quark_mit_program
addRules
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/_static/css/badge_only.css
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions docs/build/html/_static/css/theme.css
View file
Open in desktop

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions docs/build/html/addRules.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install_index.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="report.html">Report</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_script.html">Quark Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_mit_program.html">Quark MIT Program</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Add Rules</a></li>
Expand Down Expand Up @@ -70,8 +71,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Add Rules</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Add Rules</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/addRules.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand Down
7 changes: 4 additions & 3 deletions docs/build/html/coding_style.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install_index.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="report.html">Report</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_script.html">Quark Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_mit_program.html">Quark MIT Program</a></li>
<li class="toctree-l1"><a class="reference internal" href="addRules.html">Add Rules</a></li>
Expand Down Expand Up @@ -94,9 +95,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item"><a href="dev_index.html">Development</a></li>
<li class="breadcrumb-item active">Coding Style</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="dev_index.html">Development</a> &raquo;</li>
<li>Coding Style</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/coding_style.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand Down
5 changes: 3 additions & 2 deletions docs/build/html/contribution.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install_index.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="report.html">Report</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_script.html">Quark Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_mit_program.html">Quark MIT Program</a></li>
<li class="toctree-l1"><a class="reference internal" href="addRules.html">Add Rules</a></li>
Expand Down Expand Up @@ -76,8 +77,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Contribution</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Contribution</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/contribution.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand Down
7 changes: 4 additions & 3 deletions docs/build/html/dev.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install_index.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="report.html">Report</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_script.html">Quark Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_mit_program.html">Quark MIT Program</a></li>
<li class="toctree-l1"><a class="reference internal" href="addRules.html">Add Rules</a></li>
Expand Down Expand Up @@ -80,9 +81,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item"><a href="dev_index.html">Development</a></li>
<li class="breadcrumb-item active">Development Notes</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="dev_index.html">Development</a> &raquo;</li>
<li>Development Notes</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/dev.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand Down
5 changes: 3 additions & 2 deletions docs/build/html/dev_index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="install_index.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="report.html">Report</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_script.html">Quark Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_mit_program.html">Quark MIT Program</a></li>
<li class="toctree-l1"><a class="reference internal" href="addRules.html">Add Rules</a></li>
Expand Down Expand Up @@ -74,8 +75,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Development</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Development</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/dev_index.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand Down
5 changes: 3 additions & 2 deletions docs/build/html/genindex.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="install_index.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="report.html">Report</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_script.html">Quark Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_mit_program.html">Quark MIT Program</a></li>
<li class="toctree-l1"><a class="reference internal" href="addRules.html">Add Rules</a></li>
Expand Down Expand Up @@ -67,8 +68,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Index</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Index</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
Expand Down
9 changes: 7 additions & 2 deletions docs/build/html/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="install_index.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="report.html">Report</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_script.html">Quark Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_mit_program.html">Quark MIT Program</a></li>
<li class="toctree-l1"><a class="reference internal" href="addRules.html">Add Rules</a></li>
Expand Down Expand Up @@ -69,8 +70,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Quark-Engine Book</li>
<li><a href="#" class="icon icon-home"></a> &raquo;</li>
<li>Quark-Engine Book</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand All @@ -95,6 +96,10 @@ <h1>Quark-Engine Book<a class="headerlink" href="#quark-engine-book" title="Perm
<li class="toctree-l2"><a class="reference internal" href="testing.html">Testing Quark-Engine</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="report.html">Report</a><ul>
<li class="toctree-l2"><a class="reference internal" href="report.html#web-report">Web Report</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="quark_script.html">Quark Script</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quark_script.html#ecosystem-for-mobile-security-tools">Ecosystem for Mobile Security Tools</a></li>
<li class="toctree-l2"><a class="reference internal" href="quark_script.html#introduce-of-quark-script-apis">Introduce of Quark Script APIs</a></li>
Expand Down
7 changes: 4 additions & 3 deletions docs/build/html/install.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@
<li class="toctree-l2"><a class="reference internal" href="testing.html">Testing Quark-Engine</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="report.html">Report</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_script.html">Quark Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_mit_program.html">Quark MIT Program</a></li>
<li class="toctree-l1"><a class="reference internal" href="addRules.html">Add Rules</a></li>
Expand Down Expand Up @@ -74,9 +75,9 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item"><a href="install_index.html">Installation</a></li>
<li class="breadcrumb-item active">Installing Quark-Engine</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li><a href="install_index.html">Installation</a> &raquo;</li>
<li>Installing Quark-Engine</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/install.rst.txt" rel="nofollow"> View page source</a>
</li>
Expand Down
Binary file modified docs/build/html/objects.inv
View file
Open in desktop
Binary file not shown.
5 changes: 3 additions & 2 deletions docs/build/html/search.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="install_index.html">Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="report.html">Report</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_script.html">Quark Script</a></li>
<li class="toctree-l1"><a class="reference internal" href="quark_mit_program.html">Quark MIT Program</a></li>
<li class="toctree-l1"><a class="reference internal" href="addRules.html">Add Rules</a></li>
Expand Down Expand Up @@ -70,8 +71,8 @@
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home"></a></li>
<li class="breadcrumb-item active">Search</li>
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
<li>Search</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/build/html/searchindex.js
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ This guide will explain how to set up Quark, use it, and customize it.
:caption: Contents:

install_index
report
quark_script
quark_mit_program
addRules
Expand Down
Loading