From 0e46096c3e67b24d8502f793f2ad27872b9479ad Mon Sep 17 00:00:00 2001 From: Bruno Alla Date: Wed, 4 Nov 2020 13:06:22 +0000 Subject: [PATCH] Move sources in docs root Moving config inside of source fixed RTD, but broke the local setup. Move everything in docs source seems to be an easier fix --- docs/document.rst | 4 ++-- {{cookiecutter.project_slug}}/.readthedocs.yml | 2 +- {{cookiecutter.project_slug}}/docs/Makefile | 2 +- .../docs/{_source => }/conf.py | 4 ++-- .../docs/{_source => }/howto.rst | 0 .../docs/{_source => }/index.rst | 0 .../docs/{_source => }/pycharm/configuration.rst | 0 .../docs/{_source => }/pycharm/images/1.png | Bin .../docs/{_source => }/pycharm/images/2.png | Bin .../docs/{_source => }/pycharm/images/3.png | Bin .../docs/{_source => }/pycharm/images/4.png | Bin .../docs/{_source => }/pycharm/images/7.png | Bin .../docs/{_source => }/pycharm/images/8.png | Bin .../docs/{_source => }/pycharm/images/f1.png | Bin .../docs/{_source => }/pycharm/images/f2.png | Bin .../docs/{_source => }/pycharm/images/f3.png | Bin .../docs/{_source => }/pycharm/images/f4.png | Bin .../docs/{_source => }/pycharm/images/issue1.png | Bin .../docs/{_source => }/pycharm/images/issue2.png | Bin .../docs/{_source => }/users.rst | 0 20 files changed, 6 insertions(+), 6 deletions(-) rename {{cookiecutter.project_slug}}/docs/{_source => }/conf.py (96%) rename {{cookiecutter.project_slug}}/docs/{_source => }/howto.rst (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/index.rst (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/pycharm/configuration.rst (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/pycharm/images/1.png (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/pycharm/images/2.png (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/pycharm/images/3.png (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/pycharm/images/4.png (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/pycharm/images/7.png (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/pycharm/images/8.png (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/pycharm/images/f1.png (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/pycharm/images/f2.png (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/pycharm/images/f3.png (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/pycharm/images/f4.png (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/pycharm/images/issue1.png (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/pycharm/images/issue2.png (100%) rename {{cookiecutter.project_slug}}/docs/{_source => }/users.rst (100%) diff --git a/docs/document.rst b/docs/document.rst index a6e6b72f4..a30979094 100644 --- a/docs/document.rst +++ b/docs/document.rst @@ -15,12 +15,12 @@ If you set up your project to `develop locally with docker`_, run the following Navigate to port 7000 on your host to see the documentation. This will be opened automatically at `localhost`_ for local, non-docker development. -Note: using Docker for documentation sets up a temporary SQLite file by setting the environment variable ``DATABASE_URL=sqlite:///readthedocs.db`` in ``docs/_sources/conf.py`` to avoid a dependency on PostgreSQL. +Note: using Docker for documentation sets up a temporary SQLite file by setting the environment variable ``DATABASE_URL=sqlite:///readthedocs.db`` in ``docs/conf.py`` to avoid a dependency on PostgreSQL. Generate API documentation ---------------------------- -Edit the ``docs/_source`` files and project application docstrings to create your documentation. +Edit the ``docs`` files and project application docstrings to create your documentation. Sphinx can automatically include class and function signatures and docstrings in generated documentation. See the generated project documentation for more examples. diff --git a/{{cookiecutter.project_slug}}/.readthedocs.yml b/{{cookiecutter.project_slug}}/.readthedocs.yml index 3f316fdab..b193a85e0 100644 --- a/{{cookiecutter.project_slug}}/.readthedocs.yml +++ b/{{cookiecutter.project_slug}}/.readthedocs.yml @@ -1,7 +1,7 @@ version: 2 sphinx: - configuration: docs/_source/conf.py + configuration: docs/conf.py python: version: 3.8 diff --git a/{{cookiecutter.project_slug}}/docs/Makefile b/{{cookiecutter.project_slug}}/docs/Makefile index 4f772cade..0b56e1f86 100644 --- a/{{cookiecutter.project_slug}}/docs/Makefile +++ b/{{cookiecutter.project_slug}}/docs/Makefile @@ -5,7 +5,7 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build -c . -SOURCEDIR = ./_source +SOURCEDIR = . BUILDDIR = ./_build {%- if cookiecutter.use_docker == 'y' %} APP = /app diff --git a/{{cookiecutter.project_slug}}/docs/_source/conf.py b/{{cookiecutter.project_slug}}/docs/conf.py similarity index 96% rename from {{cookiecutter.project_slug}}/docs/_source/conf.py rename to {{cookiecutter.project_slug}}/docs/conf.py index 3fc411aa6..faf16e5cc 100644 --- a/{{cookiecutter.project_slug}}/docs/_source/conf.py +++ b/{{cookiecutter.project_slug}}/docs/conf.py @@ -15,7 +15,7 @@ import sys import django if os.getenv("READTHEDOCS", default=False) == "True": - sys.path.insert(0, os.path.abspath("../..")) + 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") @@ -25,7 +25,7 @@ else: {%- if cookiecutter.use_docker == 'y' %} sys.path.insert(0, os.path.abspath("/app")) {%- else %} - sys.path.insert(0, os.path.abspath("../..")) + sys.path.insert(0, os.path.abspath("..")) {%- endif %} os.environ["DATABASE_URL"] = "sqlite:///readthedocs.db" os.environ.setdefault("DJANGO_SETTINGS_MODULE", "config.settings.local") diff --git a/{{cookiecutter.project_slug}}/docs/_source/howto.rst b/{{cookiecutter.project_slug}}/docs/howto.rst similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/howto.rst rename to {{cookiecutter.project_slug}}/docs/howto.rst diff --git a/{{cookiecutter.project_slug}}/docs/_source/index.rst b/{{cookiecutter.project_slug}}/docs/index.rst similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/index.rst rename to {{cookiecutter.project_slug}}/docs/index.rst diff --git a/{{cookiecutter.project_slug}}/docs/_source/pycharm/configuration.rst b/{{cookiecutter.project_slug}}/docs/pycharm/configuration.rst similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/pycharm/configuration.rst rename to {{cookiecutter.project_slug}}/docs/pycharm/configuration.rst diff --git a/{{cookiecutter.project_slug}}/docs/_source/pycharm/images/1.png b/{{cookiecutter.project_slug}}/docs/pycharm/images/1.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/pycharm/images/1.png rename to {{cookiecutter.project_slug}}/docs/pycharm/images/1.png diff --git a/{{cookiecutter.project_slug}}/docs/_source/pycharm/images/2.png b/{{cookiecutter.project_slug}}/docs/pycharm/images/2.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/pycharm/images/2.png rename to {{cookiecutter.project_slug}}/docs/pycharm/images/2.png diff --git a/{{cookiecutter.project_slug}}/docs/_source/pycharm/images/3.png b/{{cookiecutter.project_slug}}/docs/pycharm/images/3.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/pycharm/images/3.png rename to {{cookiecutter.project_slug}}/docs/pycharm/images/3.png diff --git a/{{cookiecutter.project_slug}}/docs/_source/pycharm/images/4.png b/{{cookiecutter.project_slug}}/docs/pycharm/images/4.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/pycharm/images/4.png rename to {{cookiecutter.project_slug}}/docs/pycharm/images/4.png diff --git a/{{cookiecutter.project_slug}}/docs/_source/pycharm/images/7.png b/{{cookiecutter.project_slug}}/docs/pycharm/images/7.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/pycharm/images/7.png rename to {{cookiecutter.project_slug}}/docs/pycharm/images/7.png diff --git a/{{cookiecutter.project_slug}}/docs/_source/pycharm/images/8.png b/{{cookiecutter.project_slug}}/docs/pycharm/images/8.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/pycharm/images/8.png rename to {{cookiecutter.project_slug}}/docs/pycharm/images/8.png diff --git a/{{cookiecutter.project_slug}}/docs/_source/pycharm/images/f1.png b/{{cookiecutter.project_slug}}/docs/pycharm/images/f1.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/pycharm/images/f1.png rename to {{cookiecutter.project_slug}}/docs/pycharm/images/f1.png diff --git a/{{cookiecutter.project_slug}}/docs/_source/pycharm/images/f2.png b/{{cookiecutter.project_slug}}/docs/pycharm/images/f2.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/pycharm/images/f2.png rename to {{cookiecutter.project_slug}}/docs/pycharm/images/f2.png diff --git a/{{cookiecutter.project_slug}}/docs/_source/pycharm/images/f3.png b/{{cookiecutter.project_slug}}/docs/pycharm/images/f3.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/pycharm/images/f3.png rename to {{cookiecutter.project_slug}}/docs/pycharm/images/f3.png diff --git a/{{cookiecutter.project_slug}}/docs/_source/pycharm/images/f4.png b/{{cookiecutter.project_slug}}/docs/pycharm/images/f4.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/pycharm/images/f4.png rename to {{cookiecutter.project_slug}}/docs/pycharm/images/f4.png diff --git a/{{cookiecutter.project_slug}}/docs/_source/pycharm/images/issue1.png b/{{cookiecutter.project_slug}}/docs/pycharm/images/issue1.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/pycharm/images/issue1.png rename to {{cookiecutter.project_slug}}/docs/pycharm/images/issue1.png diff --git a/{{cookiecutter.project_slug}}/docs/_source/pycharm/images/issue2.png b/{{cookiecutter.project_slug}}/docs/pycharm/images/issue2.png similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/pycharm/images/issue2.png rename to {{cookiecutter.project_slug}}/docs/pycharm/images/issue2.png diff --git a/{{cookiecutter.project_slug}}/docs/_source/users.rst b/{{cookiecutter.project_slug}}/docs/users.rst similarity index 100% rename from {{cookiecutter.project_slug}}/docs/_source/users.rst rename to {{cookiecutter.project_slug}}/docs/users.rst