forked from fkie-cad/FACT_core
-
Notifications
You must be signed in to change notification settings - Fork 0
/
conf.py
89 lines (69 loc) · 2.68 KB
/
conf.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Path setup --------------------------------------------------------------
import sys
from pathlib import Path
FACT_SRC = Path(__file__).parent.parent / 'src'
sys.path.insert(0, str(FACT_SRC))
# -- Project information -----------------------------------------------------
# pylint: disable=redefined-builtin,invalid-name
project = 'FACT'
copyright = '2020, Fraunhofer FKIE'
author = 'jstucke'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'sphinx_rtd_theme'
# html_theme = 'alabaster'
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_logo = '../src/web_interface/static/FACT_smaller.png'
# This value contains a list of modules to be mocked up. This is useful when some external dependencies
# are not met at build time and break the building process. You may only specify the root package
autodoc_mock_imports = [
'common_helper_encoder',
'common_helper_files',
'common_helper_mongo',
'common_helper_process',
'docker',
'flask',
'gridfs',
'lief',
'matplotlib',
'passlib',
'psutil',
'pymongo',
'requests',
'si_prefix',
'ssdeep',
'tlsh',
'werkzeug',
'yaml',
'yara',
]
# This value controls how to represents typehints. The setting takes the following values:
# 'signature' – Show typehints as its signature (default)
# 'description' – Show typehints as content of function or method
# 'none' – Do not show typehints
autodoc_typehints = 'description'
def setup(app):
app.add_css_file('css/custom.css')