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 = 'vtapi3 - VirusTotal in Python' |
21
|
|
|
copyright = '2020, Evgeny Drobotun' |
22
|
|
|
author = 'Evgeny Drobotun' |
23
|
|
|
|
24
|
|
|
|
25
|
|
|
# The full version, including alpha/beta/rc tags |
26
|
|
|
release = '1.0.x' |
27
|
|
|
|
28
|
|
|
|
29
|
|
|
# -- General configuration --------------------------------------------------- |
30
|
|
|
|
31
|
|
|
# Add any Sphinx extension module names here, as strings. They can be |
32
|
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom |
33
|
|
|
# ones. |
34
|
|
|
extensions = [ |
35
|
|
|
] |
36
|
|
|
|
37
|
|
|
# Add any paths that contain templates here, relative to this directory. |
38
|
|
|
templates_path = ['_templates'] |
39
|
|
|
|
40
|
|
|
# List of patterns, relative to source directory, that match files and |
41
|
|
|
# directories to ignore when looking for source files. |
42
|
|
|
# This pattern also affects html_static_path and html_extra_path. |
43
|
|
|
exclude_patterns = [] |
44
|
|
|
|
45
|
|
|
|
46
|
|
|
# -- Options for HTML output ------------------------------------------------- |
47
|
|
|
|
48
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for |
49
|
|
|
# a list of builtin themes. |
50
|
|
|
# |
51
|
|
|
html_theme = 'sphinx_rtd_theme' |
52
|
|
|
|
53
|
|
|
# Add any paths that contain custom static files (such as style sheets) here, |
54
|
|
|
# relative to this directory. They are copied after the builtin static files, |
55
|
|
|
# so a file named "default.css" will overwrite the builtin "default.css". |
56
|
|
|
html_static_path = ['_static'] |
57
|
|
|
|
58
|
|
|
master_doc = 'index' |
59
|
|
|
|
60
|
|
|
# -- Options for LaTeX output --------------------------------------------- |
61
|
|
|
|
62
|
|
|
latex_elements = { |
63
|
|
|
# The paper size ('letterpaper' or 'a4paper'). |
64
|
|
|
#'papersize': 'letterpaper', |
65
|
|
|
|
66
|
|
|
# The font size ('10pt', '11pt' or '12pt'). |
67
|
|
|
#'pointsize': '10pt', |
68
|
|
|
|
69
|
|
|
# Additional stuff for the LaTeX preamble. |
70
|
|
|
#'preamble': '\renewcommand{\@seccntformat}[1]{}' |
71
|
|
|
} |
72
|
|
|
|