mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-03-31 14:24:16 +02:00
Added Sphinx draft
This commit is contained in:
parent
b310e176de
commit
c3c889784a
5
.gitignore
vendored
5
.gitignore
vendored
@ -1,2 +1,5 @@
|
|||||||
site.retry
|
site.retry
|
||||||
*__pycache__
|
*__pycache__
|
||||||
|
docs/*
|
||||||
|
!docs/.gitkeep
|
||||||
|
venv
|
20
Makefile
Normal file
20
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 ?=
|
||||||
|
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)
|
61
conf.py
Normal file
61
conf.py
Normal file
@ -0,0 +1,61 @@
|
|||||||
|
# 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
|
||||||
|
|
||||||
|
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 = {
|
||||||
|
'**': [
|
||||||
|
'globaltoc.html', # globales Inhaltsverzeichnis
|
||||||
|
'relations.html', # Prev/Next Navigation
|
||||||
|
'searchbox.html', # Suchfeld
|
||||||
|
]
|
||||||
|
}
|
||||||
|
html_theme_options = {
|
||||||
|
'fixed_sidebar': True,
|
||||||
|
}
|
||||||
|
|
||||||
|
# Liste der Dateiendungen, die Sphinx verarbeiten soll:
|
||||||
|
source_suffix = {
|
||||||
|
'.rst': 'restructuredtext',
|
||||||
|
'.md': 'markdown',
|
||||||
|
}
|
||||||
|
|
||||||
|
# Erweiterungen hinzufügen – MyST-Parser aktivieren:
|
||||||
|
extensions = [
|
||||||
|
'myst_parser',
|
||||||
|
# ... andere Extensions
|
||||||
|
]
|
||||||
|
|
||||||
|
# Optional: Zusätzliche MyST-Konfigurationen
|
||||||
|
myst_enable_extensions = [
|
||||||
|
"colon_fence", # Für erweiterte Syntax wie ::: Hinweisboxen etc.
|
||||||
|
# weitere Erweiterungen nach Bedarf
|
||||||
|
]
|
||||||
|
|
||||||
|
myst_xref_ignore = [
|
||||||
|
r"\./roles/.*",
|
||||||
|
"../"
|
||||||
|
]
|
||||||
|
|
0
docs/.gitkeep
Normal file
0
docs/.gitkeep
Normal file
21
index.rst
Normal file
21
index.rst
Normal file
@ -0,0 +1,21 @@
|
|||||||
|
.. CyMaIS - Cyber Master Infrastructure Solution documentation master file, created by
|
||||||
|
sphinx-quickstart on Fri Mar 14 14:55:53 2025.
|
||||||
|
You can adapt this file completely to your liking, but it should at least
|
||||||
|
contain the root `toctree` directive.
|
||||||
|
|
||||||
|
CyMaIS - Cyber Master Infrastructure Solution documentation
|
||||||
|
===========================================================
|
||||||
|
|
||||||
|
Add your content using ``reStructuredText`` syntax. See the
|
||||||
|
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
|
||||||
|
documentation for details.
|
||||||
|
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 5
|
||||||
|
:caption: Index:
|
||||||
|
:glob:
|
||||||
|
|
||||||
|
**/*.md
|
||||||
|
|
||||||
|
|
4
reuirements.yml
Normal file
4
reuirements.yml
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
pip:
|
||||||
|
myst-parser
|
||||||
|
sphinx
|
||||||
|
sphinx-rtd-theme
|
@ -2,13 +2,6 @@
|
|||||||
|
|
||||||
This Ansible role sets up and configures a Taiga project management platform using Docker. It includes tasks for setting up the database, Nginx proxy, and updating the repository with necessary files.
|
This Ansible role sets up and configures a Taiga project management platform using Docker. It includes tasks for setting up the database, Nginx proxy, and updating the repository with necessary files.
|
||||||
|
|
||||||
## Table of Contents
|
|
||||||
|
|
||||||
- [Tasks](#tasks)
|
|
||||||
- [Variables](#variables)
|
|
||||||
- [Templates](#templates)
|
|
||||||
- [Author](#author)
|
|
||||||
|
|
||||||
## Tasks
|
## Tasks
|
||||||
|
|
||||||
The main tasks included in this role are:
|
The main tasks included in this role are:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user