mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-09-10 12:27:15 +02:00
Moved sphinx files to an own folder
This commit is contained in:
20
sphinx/Makefile
Normal file
20
sphinx/Makefile
Normal file
@@ -0,0 +1,20 @@
|
||||
# Minimal makefile for Sphinx documentation
|
||||
#
|
||||
|
||||
# You can set these variables from the command line, and also
|
||||
# from the environment for the first two.
|
||||
SPHINXOPTS ?= -c .
|
||||
SPHINXBUILD ?= sphinx-build
|
||||
SOURCEDIR = ../
|
||||
BUILDDIR = ../docs
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
||||
|
||||
.PHONY: help Makefile
|
||||
|
||||
# Catch-all target: route all unknown targets to Sphinx using the new
|
||||
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
|
||||
%: Makefile
|
||||
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
|
59
sphinx/conf.py
Normal file
59
sphinx/conf.py
Normal file
@@ -0,0 +1,59 @@
|
||||
# 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
|
||||
|
||||
import sys
|
||||
|
||||
project = 'CyMaIS - Cyber Master Infrastructure Solution'
|
||||
copyright = '2025, Kevin Veen-Birkenbach'
|
||||
author = 'Kevin Veen-Birkenbach'
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
|
||||
|
||||
extensions = []
|
||||
|
||||
templates_path = ['_templates']
|
||||
exclude_patterns = ['docs', 'venv', 'venv/**']
|
||||
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
|
||||
|
||||
html_theme = 'alabaster'
|
||||
html_static_path = ['_static']
|
||||
html_sidebars = {
|
||||
'**': [
|
||||
'localtoc.html', # Zeigt die lokale Navigation an
|
||||
'relations.html', # Vorherige/Nächste Seite
|
||||
'searchbox.html', # Suchfeld
|
||||
]
|
||||
}
|
||||
|
||||
html_theme_options = {
|
||||
'fixed_sidebar': True,
|
||||
}
|
||||
|
||||
# Liste der Dateiendungen, die Sphinx verarbeiten soll:
|
||||
source_suffix = {
|
||||
'.rst': 'restructuredtext',
|
||||
'.md': 'markdown',
|
||||
}
|
||||
|
||||
extensions = [
|
||||
"sphinx.ext.autosummary",
|
||||
"sphinx.ext.autodoc",
|
||||
"myst_parser",
|
||||
]
|
||||
autosummary_generate = True
|
||||
|
||||
# Optional: Zusätzliche MyST-Konfigurationen
|
||||
myst_enable_extensions = [
|
||||
"colon_fence", # Für erweiterte Syntax wie ::: Hinweisboxen etc.
|
||||
# weitere Erweiterungen nach Bedarf
|
||||
]
|
Reference in New Issue
Block a user