Python web app to publish documentation compiled using Sphinx

Youen bac8e34245 Fixed issue when a file tracked by git is modified by previous compilation		3 months ago
src	Fixed issue when a file tracked by git is modified by previous compilation	3 months ago
.gitignore	implemented authentication to access admin pages	2 years ago
LICENSE	Initial commit	2 years ago
README.md	Added instructions to run the application in production	2 years ago
debug.sh	refactored configuration system	2 years ago
debug_config.py	refactored configuration system	2 years ago
pdftoc-to-latex	Added code to generate PDF	1 year ago
requirements.txt	Added modules for PDF compilation	12 months ago

README.md

Python web app to publish documentation compiled using Sphinx

Installation

cd sphinx-web
python3 -m venv venv
source venv/bin/activate # on Windows execute instead: venv\Scripts\activate.bat
pip install -U pip setuptools wheel
pip install -r requirements.txt

Executing in a producton environment

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:

cd sphinx-web/src
source ../venv/bin/activate
CONFIG_PATH=/etc/sphinx-web/config.py waitress-serve --port 8080 --call "app:create_app"

Development

Update dependencies

After activating the virtual environment, run this command to update the list of dependencies with what is currently installed:

pip freeze > requirements.txt