ossec-docs/conf.py at master · atomicturtle/ossec-docs · GitHub

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
# Configuration file for the Sphinx documentation builder.
#
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

import os
import sys

sys.path.insert(0, os.path.abspath('_ext'))

# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

project = 'OSSEC'
copyright = 'Atomicorp, Inc. 2025'
author = 'Atomicorp'
release = '4.1.0'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration

extensions = [
    'myst_parser',
    'xml_domain',
]

source_suffix = {
    '.rst': 'restructuredtext',
    '.md': 'markdown',
}

exclude_patterns = [
    '_build',
    'Thumbs.db',
    '.DS_Store',
    'conf.py.bak',
    '_templates/*.bak',
]

# Optional: Enable MyST extensions
myst_enable_extensions = [
    "amsmath",
    "colon_fence",
    "deflist",
    "fieldlist",
    "html_admonition",
    "html_image",
]

# Paths for custom templates and static files
templates_path = ['_templates']
html_static_path = ['_static']

html_theme = "furo"

html_css_files = [
    'custom.css',
]

html_logo = "ossec_logo_bare_small.png"