Skip to content

Commit 2f9757b

Browse files
authored
Small doc fixes in prepration for 2.0 (#959)
* Small doc fixes in prepration for 2.0 * Update version in conf.py to 2.0
1 parent e304cc2 commit 2f9757b

File tree

7 files changed

+6
-12
lines changed

7 files changed

+6
-12
lines changed

doc/MANUAL.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
## Table of Contents
2-
31
- [CVE Binary Tool User Manual](#cve-binary-tool-user-manual)
42
- [How it works](#how-it-works)
53
- [Installing](#installing)

doc/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
author = "Terri Oda"
2323

2424
# The full version, including alpha/beta/rc tags
25-
release = "1.1"
25+
release = "2.0"
2626

2727

2828
# -- General configuration ---------------------------------------------------

doc/how_to_guides/customize_html_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
# How to create a custom theme for the HTML Report?
2+
# How do I create a custom theme for the HTML Report?
33

44
CVE Binary Tool provides HTML Report as an output type and although the Report design will work for most of the users it might be the case that we want to update the Report Design according to our needs. So in this tutorial, we will be discussing on how to customise the HTML Report.
55

doc/how_to_guides/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,4 @@ How To Guides
1212

1313
customize_html_report
1414
scan_docker_image
15+
offline

doc/how_to_guides/offline.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
# Use in an offline environment
1+
# How do I use CVE Binary Tool in an offline environment?
2+
23
The cve-bin-tool can be used in offline environments which do not have direct access to the internet to download the latest vulnerability databases.
34

45
## Prepare the vulnerability database for offline use

doc/index.rst

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,6 @@ The CVE Binary Tool helps you determine if your system includes known vulnerabil
1919
RELEASE.md
2020
CONTRIBUTORS.md
2121

22-
1.0/index
23-
0.3.1/index
24-
0.3.0/index
25-
0.2.0/index
26-
27-
28-
2922
Indices and tables
3023
==================
3124

doc/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
recommonmark==0.6.0
22
Sphinx==3.2.1
3+
sphinx_markdown_tables

0 commit comments

Comments
 (0)