added initial sphinx config for book generation

This commit is contained in:
Gulliver 2021-07-29 09:41:29 +02:00
parent 3e5409afe4
commit 326d665f4f
4 changed files with 112 additions and 0 deletions

20
sphinx/Makefile Normal file
View 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 = 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)

66
sphinx/source/conf.py Normal file
View File

@ -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']

1
sphinx/source/handbuch Symbolic link
View File

@ -0,0 +1 @@
../../handbuch/

25
sphinx/source/index.rst Normal file
View File

@ -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`