From 92cafc618f71efe9ce58cd92e691772c8b10c3f3 Mon Sep 17 00:00:00 2001 From: Andrew Chen Wang <60190294+Andrew-Chen-Wang@users.noreply.github.com> Date: Sat, 15 Aug 2020 17:10:00 -0400 Subject: [PATCH] Add RTD Support * Sample URL: https://test-cookiecutter-django-rtd.readthedocs.io/en/latest/_source/howto.html# * Issue: you must go to /_source for this to work due to how the docs/* configuration is setup up. --- {{cookiecutter.project_slug}}/docs/conf.py | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) diff --git a/{{cookiecutter.project_slug}}/docs/conf.py b/{{cookiecutter.project_slug}}/docs/conf.py index 691f351e5..3ebe748dd 100644 --- a/{{cookiecutter.project_slug}}/docs/conf.py +++ b/{{cookiecutter.project_slug}}/docs/conf.py @@ -14,11 +14,20 @@ import os import sys import django +if os.getenv("READTHEDOCS", default=False) == "True": + sys.path.insert(0, os.path.abspath("..")) + os.environ["DJANGO_READ_DOT_ENV_FILE"] = "True" + {% if cookiecutter.use_celery == 'y' -%} + os.environ["CELERY_BROKER_URL"] = os.getenv("REDIS_URL", "redis://redis:6379") + {%- endif %} + os.environ["USE_DOCKER"] = "no" + master_doc = "_source/index" +else: {% if cookiecutter.use_docker == 'y' %} -sys.path.insert(0, os.path.abspath("/app")) -os.environ.setdefault("DATABASE_URL", "") + sys.path.insert(0, os.path.abspath("/app")) + os.environ.setdefault("DATABASE_URL", "") {% else %} -sys.path.insert(0, os.path.abspath("..")) + sys.path.insert(0, os.path.abspath("..")) {%- endif %} os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.local") django.setup()