From 326d665f4f6f487236de44851d25b4096d255ad6 Mon Sep 17 00:00:00 2001 From: Gulliver Date: Thu, 29 Jul 2021 09:41:29 +0200 Subject: [PATCH] added initial sphinx config for book generation --- sphinx/Makefile | 20 +++++++++++++ sphinx/source/conf.py | 66 +++++++++++++++++++++++++++++++++++++++++ sphinx/source/handbuch | 1 + sphinx/source/index.rst | 25 ++++++++++++++++ 4 files changed, 112 insertions(+) create mode 100644 sphinx/Makefile create mode 100644 sphinx/source/conf.py create mode 120000 sphinx/source/handbuch create mode 100644 sphinx/source/index.rst diff --git a/sphinx/Makefile b/sphinx/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/sphinx/Makefile @@ -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 = source +BUILDDIR = build + +# 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) diff --git a/sphinx/source/conf.py b/sphinx/source/conf.py new file mode 100644 index 0000000..487c60e --- /dev/null +++ b/sphinx/source/conf.py @@ -0,0 +1,66 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys +#sys.path.insert(0, os.path.abspath('.')) +#sys.path.insert(0, os.path.abspath('..')) + + + +# -- Project information ----------------------------------------------------- + +project = 'Das Handbuch zur WTF eG' +copyright = '2021, diverse' +author = 'evi, helix' + +# The full version, including alpha/beta/rc tags +release = '0.0.0' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ + 'sphinxcontrib.plantuml', + 'myst_parser' +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = 'de' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = [] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'alabaster' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] diff --git a/sphinx/source/handbuch b/sphinx/source/handbuch new file mode 120000 index 0000000..9dd42c5 --- /dev/null +++ b/sphinx/source/handbuch @@ -0,0 +1 @@ +../../handbuch/ \ No newline at end of file diff --git a/sphinx/source/index.rst b/sphinx/source/index.rst new file mode 100644 index 0000000..8038e4c --- /dev/null +++ b/sphinx/source/index.rst @@ -0,0 +1,25 @@ +.. KoLe documentation master file, created by + sphinx-quickstart on Thu Apr 29 23:32:19 2021. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +RTFM - Das Handbuch zur wtf Kooperative eG +=========================================== + +.. toctree:: + :maxdepth: 4 + :caption: Contents: + + handbuch/README.md + handbuch/FAQ.md + handbuch/Aufnahmeprozess.md + handbuch/Auszahlung.md + handbuch/RaaS.md + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` +