Skip to content

Commit 8bff0de

Browse files
committed
ref(docs): remove postgresql from doc generation requirements
To automatically generate python code documentation, Sphinx needs to import the code, which requires Django, which requires a database driver. This change sets the driver to the built-in sqlite3 at runtime to simplify requirements for building the docs.
1 parent b2372c0 commit 8bff0de

3 files changed

Lines changed: 3 additions & 1 deletion

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ deisctl/package/
4040
deisctl/makeself/
4141
docs/_build/
4242
docs/docs.zip
43+
docs/dummy.sqlite3
4344
logspout/build/
4445
logspout/image/logspout
4546
logspout/Godeps/

docs/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,8 @@
3030
local_settings.write("SECRET_KEY = 'DummySecretKey'\n")
3131
# set up Django
3232
os.environ['DJANGO_SETTINGS_MODULE'] = 'deis.settings'
33+
os.environ['DATABASE_ENGINE'] = 'sqlite3'
34+
os.environ['DATABASE_NAME'] = 'dummy.sqlite3'
3335
from django.conf import settings # noqa
3436

3537
# -- General configuration -----------------------------------------------------

docs/docs_requirements.txt

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,6 @@ djangorestframework==3.0.3
1717
docker-py==0.6.0
1818
gunicorn==19.1.1
1919
paramiko==1.15.2
20-
psycopg2==2.5.4
2120
python-etcd==0.3.2
2221
PyYAML==3.11
2322
South==1.0.2

0 commit comments

Comments
 (0)