From 121076f9f1d82bbed394e368f2cd9dba2bbad1f3 Mon Sep 17 00:00:00 2001 From: Christian Merten Date: Sun, 24 Nov 2024 19:56:45 +0100 Subject: [PATCH] docs: initial setup --- docker/development/docker-compose.yaml | 1 + docs/Makefile | 20 +++++++++++++++ docs/make.bat | 35 ++++++++++++++++++++++++++ docs/source/conf.py | 28 +++++++++++++++++++++ docs/source/getstarted.rst | 4 +++ docs/source/index.rst | 17 +++++++++++++ docs/source/members.rst | 4 +++ requirements.txt | 20 +++++++++++++-- 8 files changed, 127 insertions(+), 2 deletions(-) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/conf.py create mode 100644 docs/source/getstarted.rst create mode 100644 docs/source/index.rst create mode 100644 docs/source/members.rst diff --git a/docker/development/docker-compose.yaml b/docker/development/docker-compose.yaml index 0171b1f..1359766 100644 --- a/docker/development/docker-compose.yaml +++ b/docker/development/docker-compose.yaml @@ -23,6 +23,7 @@ services: tty: true volumes: - ./../../jdav_web:/app/jdav_web + - ./../../docs:/app/docs - ./media:/app/media ports: - "8000:8000" diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/docs/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/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..747ffb7 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..e3ff583 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,28 @@ +# 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 = 'Kompass' +copyright = '2024, Christian Merten' +author = 'Christian Merten' +release = '2.0' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [] + +templates_path = ['_templates'] +exclude_patterns = [] + +language = 'de' + +# -- 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'] diff --git a/docs/source/getstarted.rst b/docs/source/getstarted.rst new file mode 100644 index 0000000..916f04e --- /dev/null +++ b/docs/source/getstarted.rst @@ -0,0 +1,4 @@ +Erste Schritte +============== + +Wenn du das erste Mal den Kompass deiner Sektion benutzt, landest du hier. diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..f7fe6c1 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,17 @@ +.. Kompass documentation master file, created by + sphinx-quickstart on Sun Nov 24 18:37:20 2024. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +======= +Kompass +======= + +Kompass ist eine Verwaltungsplattform entwickelt für JDAV Sektionen. + +.. toctree:: + :maxdepth: 2 + :caption: Inhaltsverzeichnis: + + getstarted + members diff --git a/docs/source/members.rst b/docs/source/members.rst new file mode 100644 index 0000000..6bcb320 --- /dev/null +++ b/docs/source/members.rst @@ -0,0 +1,4 @@ +Jugendgruppenverwaltung +======================= + +Das wichtigste Objekt ist der Teilnehmer. diff --git a/requirements.txt b/requirements.txt index 14d820b..b490373 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,6 +1,8 @@ +alabaster==0.7.16 amqp==5.0.9 asgiref==3.4.1 auditlog3==1.0.1 +babel==2.16.0 bcrypt==4.0.1 billiard==3.6.4.0 bleach==6.0.0 @@ -23,14 +25,19 @@ django-markdownx==4.0.2 django-nested-admin==4.0.2 django-split-settings==1.2.0 django-timezone-field==5.0 +docutils==0.21.2 idna==3.3 +imagesize==1.4.1 importlib-metadata==6.2.0 +Jinja2==3.1.4 kombu==5.2.3 Markdown==3.4.3 +MarkupSafe==3.0.2 mysqlclient==2.1.0 -packaging==21.3 +packaging==24.2 Pillow==9.0.0 prompt-toolkit==3.0.24 +Pygments==2.18.0 pymemcache==4.0.0 pyparsing==3.0.6 pypdf==5.0.1 @@ -39,11 +46,20 @@ python-dateutil==2.8.2 python-monkey-business==1.0.0 pytz==2021.3 redis==4.1.0 -requests==2.27.1 +requests==2.32.3 rules==3.3 six==1.16.0 +snowballstemmer==2.2.0 +Sphinx==7.4.7 +sphinxcontrib-applehelp==2.0.0 +sphinxcontrib-devhelp==2.0.0 +sphinxcontrib-htmlhelp==2.1.0 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-qthelp==2.0.0 +sphinxcontrib-serializinghtml==2.0.0 sqlparse==0.4.2 tinycss2==1.1.1 +tomli==2.1.0 typing_extensions==4.12.2 tzdata==2022.7 urllib3==1.26.8