Teile der Readme in die Dokumentation übernommen

demostat · Mar 17, 2019 · 9b0396c · 9b0396c
1 parent 6357414
commit 9b0396c
Show file tree

Hide file tree

Showing 5 changed files with 115 additions and 79 deletions.
diff --git a/README.md b/README.md
@@ -27,67 +27,6 @@ Jeder Demo wir ein Ort und eine Organisation zugeordnet. Neben Name und kurzer B
 Jede Organisation hat einen Namen, eine kurze Beschreibung und einen Link zur Homepage.
 
 ## Installation
-### Eigenständige Entwicklungsversion
-Demostat Entwicklungsversion herunterladen:
-```
-git clone -b dev https://github.com/demostat/demostat.git
-```
-
-Abhängigkeiten installieren:
-```
-pip3 install -r demostat/requirements.txt
-```
-
-Neues Django Projekt starten:
-```
-django-admin startproject mysite
-cd mysite
-```
-
-Demostat einbinden:
-```
-ln -s ../demostat/demostat
-```
-
-Füge in `mysite/settings.py` Demostat zu `INSTALLED_APPS` hinzu:
-```
-INSTALLED_APPS = [
-  'demostat',
-  ...
-]
-```
-Beachte, dass Django-Admin ebenfalls geladen wird. (In der Standartinstallation sollte das schon geschehen sein)
-
-Binde in `mysite/urls.py` Demostat-Urls ein:
-```
-from django.urls import include
-
-urlpatterns = [
-  path('', include('demostat.urls')),
-  ...
-]
-```
-
-Datenbank-Migrieren:
-```
-python3 manage.py migrate
-```
-
-Erstelle Administrationsaccount:
-```
-python3 manage.py createsuperuser
-```
-
-Starte Webserver:
-```
-python3 manage.py runserver
-```
-
-Website ist erreichbar über:
-http://127.0.0.1:8000/
-
-Administration über:
-http://127.0.0.1:8000/admin/
 
 ## Live Betrieb
 
@@ -221,23 +160,6 @@ systemctl reload apache2
 systemctl reload apache2
 ```
 
-## Konfigurationen
-Es ist möglich Demostat über Variablen in `mysite/settings.py` zu konfigurieren.
-
-Alle Angaben sind Optional. Entweder haben werden sie durch Vorbelegungen ersetzt oder einfach nicht angzeigt.
-
-### String `SITE_TITLE`
-Wird als Titel im Header und der Navigation genutzt.
-```
-SITE_TITLE = "Demos in Erfurt"
-```
-
-### Url `SITE_IMPRINT_URL`
-Url zum Impressum, wird im Footer angezeigt.
-
-### Url `SITE_PRIVACY_URL`
-Url zur Datenschutzerklärung, wird im Footer angezeigt.
-
 ## Lizenz
 Diese Software hat **noch** keine Lizenz. Das bedeutet, dass das deutsche Urherberrecht gilt.
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -77,7 +77,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+#html_theme = 'alabaster'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/docs/conf.rst b/docs/conf.rst
@@ -0,0 +1,26 @@
+Konfiguration
+=============
+
+Es ist möglich Demostat über Variablen in `mysite/settings.py` zu konfigurieren.
+
+Alle Angaben sind Optional. Entweder haben werden sie durch Vorbelegungen ersetzt oder einfach nicht angzeigt.
+
+String `SITE_TITLE`
+-------------------
+
+Wird als Titel im Header und der Navigation genutzt.
+
+::
+
+    SITE_TITLE = "Demos in Erfurt"
+
+
+Url `SITE_IMPRINT_URL`
+----------------------
+
+Url zum Impressum, wird im Footer angezeigt.
+
+Url `SITE_PRIVACY_URL`
+----------------------
+
+Url zur Datenschutzerklärung, wird im Footer angezeigt.
diff --git a/docs/deploy.rst b/docs/deploy.rst
@@ -0,0 +1,85 @@
+Installieren
+============
+
+Eigenständige Entwicklungsversion
+---------------------------------
+
+Demostat Entwicklungsversion herunterladen:
+
+::
+
+    git clone -b dev https://github.com/demostat/demostat.git
+
+
+Abhängigkeiten installieren:
+
+::
+
+    pip3 install -r demostat/requirements.txt
+
+
+Neues Django Projekt starten:
+
+::
+
+    django-admin startproject mysite
+    cd mysite
+
+
+Demostat einbinden:
+
+::
+
+    ln -s ../demostat/demostat
+
+
+Füge in `mysite/settings.py` Demostat zu `INSTALLED_APPS` hinzu:
+
+::
+
+    INSTALLED_APPS = [
+      'demostat',
+    ...
+    ]
+
+
+Beachte, dass Django-Admin ebenfalls geladen wird. (In der Standartinstallation sollte das schon geschehen sein)
+
+Binde in `mysite/urls.py` Demostat-Urls ein:
+
+::
+
+    from django.urls import include
+
+    urlpatterns = [
+      path('', include('demostat.urls')),
+      ...
+    ]
+
+
+Datenbank-Migrieren:
+
+::
+
+    python3 manage.py migrate
+
+
+Erstelle Administrationsaccount:
+
+::
+
+    python3 manage.py createsuperuser
+
+
+Starte Webserver:
+
+::
+
+    python3 manage.py runserver
+
+
+Website ist erreichbar über:
+http://127.0.0.1:8000/
+
+Administration über:
+http://127.0.0.1:8000/admin/
diff --git a/docs/index.rst b/docs/index.rst
@@ -5,6 +5,9 @@ Willkommen zu Demostat!
    :maxdepth: 2
    :caption: Contents:
 
+   deploy
+   conf
+
 Über
 ====