2024-07-15 09:30:03 +00:00
|
|
|
# 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
|
|
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
|
2024-09-17 16:28:35 +00:00
|
|
|
import os
|
2024-07-15 09:30:03 +00:00
|
|
|
|
2024-09-17 16:28:35 +00:00
|
|
|
project = 'Samsung S7'
|
|
|
|
copyright = '2024, Nederlands Forensisch Instituut'
|
|
|
|
author = 'Eljakim Herrewijnen, Jonathan Herrewijnen'
|
2024-07-15 09:30:03 +00:00
|
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
|
|
|
|
|
|
|
extensions = [ 'myst_parser',
|
|
|
|
'sphinx.ext.todo',
|
|
|
|
'sphinxcontrib.confluencebuilder',
|
|
|
|
"sphinxcontrib.drawio",
|
2024-07-31 19:11:24 +00:00
|
|
|
'sphinx_wagtail_theme',
|
2024-07-15 09:30:03 +00:00
|
|
|
]
|
|
|
|
|
2024-09-17 16:28:35 +00:00
|
|
|
# -- Settings for confluence -------------------------------------------------
|
|
|
|
confluence_publish = True # Set to True to publish to confluence
|
|
|
|
confluence_space_key = 'DTSPHINX' # E.g., DT_Sphinx
|
|
|
|
confluence_server_url = 'https://confluence.dev.holmes.nl/'
|
|
|
|
confluence_parent_page = 'Automotive' # E.g., Workshops
|
|
|
|
confluence_page_hierarchy = True
|
|
|
|
confluence_publish_dryrun = False # Set to False to publish to confluence
|
|
|
|
|
|
|
|
# Use token for authentication, from environment variable
|
|
|
|
try:
|
|
|
|
confluence_publish_token = os.environ['CONFLUENCE_TOKEN']
|
|
|
|
except:
|
|
|
|
confluence_ask_password = True
|
|
|
|
confluence_ask_user = True
|
|
|
|
|
2024-07-15 09:30:03 +00:00
|
|
|
templates_path = ['_templates']
|
|
|
|
exclude_patterns = []
|
|
|
|
|
2024-08-21 17:00:18 +00:00
|
|
|
# Ignore
|
|
|
|
exclude_patterns = ['_ignore']
|
2024-07-15 09:30:03 +00:00
|
|
|
|
2024-07-31 19:11:24 +00:00
|
|
|
# select the theme
|
|
|
|
html_theme = 'sphinx_wagtail_theme'
|
2024-07-15 09:30:03 +00:00
|
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
|
|
|
|
|
|
|
html_static_path = ['_static']
|