Fixed formatting issue in docs
parent
c560aaf2f2
commit
f40bf2fb95
|
@ -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"
|
||||
|
|
|
@ -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
|
|
@ -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
|
||||
|
|
Loading…
Reference in New Issue