Skip to content
This repository has been archived by the owner on Dec 26, 2023. It is now read-only.

howto compile docs #66

Open
nerdoc opened this issue May 16, 2022 · 0 comments
Open

howto compile docs #66

nerdoc opened this issue May 16, 2022 · 0 comments

Comments

@nerdoc
Copy link
Contributor

nerdoc commented May 16, 2022

I tried to add some hints in the docs - but I want to compile the sphinx/docs locally first.
But when I go into the doc dir, start automake.sh and change something, I get the error:

WARNING: autodoc: failed to import class 'components.BroadcastComponent' from module 'turbo'; the following exception was raised:
Traceback (most recent call last):
  File "/.../turbo-django/.venv/lib/python3.10/site-packages/sphinx/ext/autodoc/importer.py", line 62, in import_module
    return importlib.import_module(modname)
[...]
  File "/.../turbo-django/.venv/lib/python3.10/site-packages/django/conf/__init__.py", line 63, in _setup
    raise ImproperlyConfigured(
django.core.exceptions.ImproperlyConfigured: Requested setting SECRET_KEY, but settings are not configured. You must either define the environment variable DJANGO_SETTINGS_MODULE or call settings.configure() before accessing settings.
[...]

This seems to me that the docs try to import Django. One solution is to (fake) import django in conf.py - but I don't know how you do that in your environment.
@scuml could you provide some hints how to do that?

If you want I can add a section for testing as well then - pytest runs fine here localy for the whole suite.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant