From f40bf2fb95ffd9147592af690e859a3002f00821 Mon Sep 17 00:00:00 2001 From: Joey Hines Date: Fri, 10 May 2019 20:51:06 -0500 Subject: [PATCH] Fixed formatting issue in docs --- GeoffreyApp/docs/source/conf.py | 2 ++ GeoffreyApp/docs/source/django_settings.rst | 10 ++++++++++ GeoffreyApp/docs/source/getting_started.rst | 20 +++++++++++++++++--- 3 files changed, 29 insertions(+), 3 deletions(-) diff --git a/GeoffreyApp/docs/source/conf.py b/GeoffreyApp/docs/source/conf.py index 186d831..8dc8ed8 100644 --- a/GeoffreyApp/docs/source/conf.py +++ b/GeoffreyApp/docs/source/conf.py @@ -173,3 +173,5 @@ epub_title = project # A list of files that should not be packed into the epub file. epub_exclude_files = ['search.html'] + +html_favicon = "../../static/GeoffreyApp/img/icon.png" diff --git a/GeoffreyApp/docs/source/django_settings.rst b/GeoffreyApp/docs/source/django_settings.rst index 5301263..ddff182 100644 --- a/GeoffreyApp/docs/source/django_settings.rst +++ b/GeoffreyApp/docs/source/django_settings.rst @@ -7,17 +7,27 @@ Django Settings Geoffrey App Settings ********************* ``GEOFFREY_NORTH_TUNNEL`` - North Nether tunnel name + ``GEOFFREY_EAST_TUNNEL`` - East Nether tunnel name + ``GEOFFREY_SOUTH_TUNNEL`` - South Nether tunnel name + ``GEOFFREY_WEST_TUNNEL`` - West Nether tunnel name + ``GEOFFREY_DYNMAP_BASE_URL`` - Dynmap URL + ``GEOFFREY_DYNMAP_WORLD_NAME`` - Overworld name for dynmap + ``GEOFFREY_MCM_API_TOKEN`` - Token for accessing the MCM API + ``GEOFFREY_MCM_BASE_URL`` - MCM base link Geoffrey Discord Bot Settings ***************************** ``GEOFFREY_BOT_PREFIX`` - Discord bot prefix + ``GEOFFREY_BOT_ERROR_USERS`` - List of Discord user IDs to send a PM on an error + ``GEOFFREY_BOT_MOD_RANKS`` - List of Discord rank IDs to grant mod privileges to + ``GEOFFREY_BOT_STATUS`` - Default bot playing stats \ No newline at end of file diff --git a/GeoffreyApp/docs/source/getting_started.rst b/GeoffreyApp/docs/source/getting_started.rst index 7dcfdc9..7cb5a82 100644 --- a/GeoffreyApp/docs/source/getting_started.rst +++ b/GeoffreyApp/docs/source/getting_started.rst @@ -28,13 +28,26 @@ Setup .. _here: https://docs.djangoproject.com/en/2.2/intro/tutorial01/ -Clone Geoffrey -************** -In the Django project, clone import Geoffrey by cloning it +Installing GeoffreyApp From Source +********************************** +1. Download Geoffrey by cloning it :: git clone https://git.etztech.xyz/ZeroHD/Geoffrey.git GeoffreyApp +2. Change directories into GeoffreyApp + +3. Package Geoffrey +:: + + python setup.py sdist + +4. Install Geoffrey as a module +:: + + pip3 install dist/GeoffreyApp-2.0.tar.gz + + Integrate Geoffrey Into The Django Project ****************************************** In ``settings.py`` add ``GeoffreyApp`` to ``INSTALLED_APPS`` @@ -47,6 +60,7 @@ Once installed, run the migrations to setup the database for the first time Then add the URLs to your projects's ``urls.py`` :: + path('GeoffreyApp/', include('GeoffreyApp.urls')), Setup Settings