|
|
|
@ -6,7 +6,31 @@ Python web app to publish documentation compiled using Sphinx
|
|
|
|
|
cd sphinx-web |
|
|
|
|
python3 -m venv venv |
|
|
|
|
source venv/bin/activate # on Windows execute instead: venv\Scripts\activate.bat |
|
|
|
|
python3 -m pip install -r requirements.txt |
|
|
|
|
pip install -U pip setuptools wheel |
|
|
|
|
pip install -r requirements.txt |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
# Executing in a producton environment |
|
|
|
|
|
|
|
|
|
``` shell |
|
|
|
|
cd sphinx-web |
|
|
|
|
source venv/bin/activate |
|
|
|
|
pip install waitress |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
Create your configuration file, for example `/etc/sphinx-web/config.py`: |
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
ADMIN_PASSWORD = 'specify a strong password here' |
|
|
|
|
BEHIND_REVERSE_PROXY = False # Set to True if you use a reverse proxy such as nginx |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
Start the application: |
|
|
|
|
|
|
|
|
|
``` shell |
|
|
|
|
cd sphinx-web/src |
|
|
|
|
source ../venv/bin/activate |
|
|
|
|
CONFIG_PATH=/etc/sphinx-web/config.py waitress-serve --port 8080 --call "app:create_app" |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
# Development |
|
|
|
|