Skip to content

Commit 0cd9827

Browse files
committed
Add conf.py, fix bad links
1 parent c4a33cc commit 0cd9827

File tree

4 files changed

+62
-3
lines changed

4 files changed

+62
-3
lines changed

doc/MANUAL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ known CVEs.
7373

7474
A [list of currently available checkers](https://github.com/intel/cve-bin-tool/tree/master/cve_bin_tool/checkers) can be found in the checkers
7575
directory, as can the [instructions on how to add a new
76-
checker](cve_bin_tool/checkers/README.md). Support for new checkers can be requested
76+
checker](https://github.com/intel/cve-bin-tool/blob/master/cve_bin_tool/checkers/README.md). Support for new checkers can be requested
7777
via [GitHub
7878
issues](https://github.com/intel/cve-bin-tool/issues).
7979
(Please note, you will need to be logged in to add a new issue.)

doc/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ match certain vulnerable versions of the following libraries and tools:
9797
* zlib
9898

9999
All the checkers can be found in the checkers directory, as can the
100-
[instructions on how to add a new checker](cve_bin_tool/checkers/README.md).
100+
[instructions on how to add a new checker](https://github.com/intel/cve-bin-tool/blob/master/cve_bin_tool/checkers/README.md).
101101
Support for new checkers can be requested via
102102
[GitHub issues](https://github.com/intel/cve-bin-tool/issues).
103103

doc/conf.py

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# This file only contains a selection of the most common options. For a full
4+
# list see the documentation:
5+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
6+
7+
# -- Path setup --------------------------------------------------------------
8+
9+
# If extensions (or modules to document with autodoc) are in another directory,
10+
# add these directories to sys.path here. If the directory is relative to the
11+
# documentation root, use os.path.abspath to make it absolute, like shown here.
12+
#
13+
# import os
14+
# import sys
15+
# sys.path.insert(0, os.path.abspath('.'))
16+
17+
18+
# -- Project information -----------------------------------------------------
19+
20+
project = "CVE Binary Tool"
21+
copyright = "2020, Terri Oda"
22+
author = "Terri Oda"
23+
24+
# The full version, including alpha/beta/rc tags
25+
release = "1.1"
26+
27+
28+
# -- General configuration ---------------------------------------------------
29+
30+
source_parsers = {
31+
".md": "recommonmark.parser.CommonMarkParser",
32+
}
33+
34+
source_suffix = [".rst", ".md"]
35+
36+
# Add any Sphinx extension module names here, as strings. They can be
37+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
38+
# ones.
39+
extensions = ["recommonmark", "sphinx_markdown_tables"]
40+
41+
# Add any paths that contain templates here, relative to this directory.
42+
templates_path = ["_templates"]
43+
44+
# List of patterns, relative to source directory, that match files and
45+
# directories to ignore when looking for source files.
46+
# This pattern also affects html_static_path and html_extra_path.
47+
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
48+
49+
50+
# -- Options for HTML output -------------------------------------------------
51+
52+
# The theme to use for HTML and HTML Help pages. See the documentation for
53+
# a list of builtin themes.
54+
#
55+
html_theme = "alabaster"
56+
57+
# Add any paths that contain custom static files (such as style sheets) here,
58+
# relative to this directory. They are copied after the builtin static files,
59+
# so a file named "default.css" will overwrite the builtin "default.css".
60+
html_static_path = ["_static"]

doc/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ The CVE Binary Tool helps you determine if your system includes known vulnerabil
1717
CSV2CVE.md
1818
RELEASE.md
1919
STYLEGUIDE.md
20-
CONTRIBUTORS.md
2120
checkers.md
2221
test.md
2322

0 commit comments

Comments
 (0)